@northflank/js-client 0.7.0 → 0.7.1-beta.0

package/dist/esm/endpoints/update/service/healthChecks.d.ts

@@ -1,45 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type UpdateServiceHealthchecksResult = any;
-export declare type UpdateServiceHealthchecksCall = (opts: UpdateServiceHealthchecksRequest) => Promise<ApiCallResponse<UpdateServiceHealthchecksResult>>;
-export declare type UpdateServiceHealthchecksRequest = {
-    parameters: UpdateServiceHealthchecksParameters;
-    data: UpdateServiceHealthchecksData;
-};
-export declare type UpdateServiceHealthchecksParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-export declare type UpdateServiceHealthchecksData = {
-    /** An array of health checks. */
-    'healthChecks': {
-        /** The protocol to access the health check with. Example: "HTTP" */
-        'protocol': 'HTTP' | 'CMD' | 'TCP';
-        /** The type of health check. Example: "readinessProbe" */
-        'type': 'livenessProbe' | 'readinessProbe' | 'startupProbe';
-        /** The path of the health check endpoint. Required when protocol is HTTP. Example: "/health-check" */
-        'path'?: string;
-        /** The command to run for the health check. Required when protocol is CMD */
-        'cmd'?: string;
-        /** Port number for the health check endpoint. Required when protocol is HTTP. Example: 8080 */
-        'port'?: number;
-        /** Initial delay, in seconds, before the health check is first run. Example: 10 */
-        'initialDelaySeconds': number;
-        /** The time between each check, in seconds. Example: 60 */
-        'periodSeconds': number;
-        /** The time to wait for a response before marking the health check as a failure. Example: 1 */
-        'timeoutSeconds': number;
-        /** The maximum number of allowed failures. Example: 3 */
-        'failureThreshold': number;
-        /** The number of successes required to mark the health check as a success. Example: 1 */
-        'successThreshold'?: number;
-    }[];
-};
-/** Updates health checks for the given service. */
-export declare class UpdateServiceHealthchecksEndpoint extends PostApiEndpoint<UpdateServiceHealthchecksRequest, UpdateServiceHealthchecksResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: UpdateServiceHealthchecksRequest) => string;
-    body: (payload: UpdateServiceHealthchecksRequest) => string;
-}

package/dist/esm/endpoints/update/service/ports.d.ts

@@ -1,57 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type UpdateServicePortsResult = any | any;
-export declare type UpdateServicePortsCall = (opts: UpdateServicePortsRequest) => Promise<ApiCallResponse<UpdateServicePortsResult>>;
-export declare type UpdateServicePortsRequest = {
-    parameters: UpdateServicePortsParameters;
-    data: UpdateServicePortsData;
-};
-export declare type UpdateServicePortsParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-export declare type UpdateServicePortsData = {
-    /** An array of ports to replace or update existing ports with. */
-    'ports': {
-        /** The id of an existing port. Pass this when changing in order to keep security configurations. Example: "p01" */
-        'id'?: string;
-        /** The name used to identify the port. Example: "port-1" */
-        'name': string;
-        /** The port number. Example: 12345 */
-        'internalPort': number;
-        /** If true, the port will be exposed publicly. Example: true */
-        'public'?: boolean;
-        /** The protocol to use for the port. Public ports only support `HTTP` and `HTTP/2`. Example: "HTTP" */
-        'protocol': 'HTTP' | 'HTTP/2' | 'TCP' | 'UDP';
-        /** An array of domains to redirect to this port. Each domain must first be verified and registered to your account. */
-        'domains'?: string[];
-        'security'?: {
-            /** An array of credentials to access the service. */
-            'credentials'?: {
-                /** The username to access the service Example: "admin" */
-                'username': string;
-                /** The password to access the service with this username. Example: "password123" */
-                'password': string;
-                /** The type of authentication used Example: "basic-auth" */
-                'type': 'basic-auth';
-            }[];
-            /** An array of IP address policies. */
-            'policies'?: {
-                /** An array of IP addresses used for this rule */
-                'addresses': string[];
-                /** The action for this rule. Example: "DENY" */
-                'action': 'ALLOW' | 'DENY';
-            }[];
-        };
-        /** Disable routing on the default code.run domain for public HTTP ports with custom domains. */
-        'disableNfDomain'?: boolean;
-    }[];
-};
-/** Updates the list of ports for the given service. */
-export declare class UpdateServicePortsEndpoint extends PostApiEndpoint<UpdateServicePortsRequest, UpdateServicePortsResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: UpdateServicePortsRequest) => string;
-    body: (payload: UpdateServicePortsRequest) => string;
-}

package/dist/esm/endpoints/update/service/runtimeEnvironment.d.ts

@@ -1,34 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../../api-endpoint';
-export declare type UpdateServiceRuntimeenvironmentResult = {
-    /** True if the operation was successful. Example: true */
-    'success': boolean;
-    /** Did the service successfully restart with the new environment variables? Example: true */
-    'restartSuccessful': boolean;
-};
-export declare type UpdateServiceRuntimeenvironmentCall = (opts: UpdateServiceRuntimeenvironmentRequest) => Promise<ApiCallResponse<UpdateServiceRuntimeenvironmentResult>>;
-export declare type UpdateServiceRuntimeenvironmentRequest = {
-    parameters: UpdateServiceRuntimeenvironmentParameters;
-    data: UpdateServiceRuntimeenvironmentData;
-};
-export declare type UpdateServiceRuntimeenvironmentParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the service */
-    'serviceId': string;
-};
-export declare type UpdateServiceRuntimeenvironmentData = {
-    /** An object containing the all of the environment variables to set for the service. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
-    'runtimeEnvironment': any;
-} | {
-    /** An object containing the all of the environment variables to set for the service. Keys must only contain letters and numbers separated with underscores, may not start with a number Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
-    'runtimeEnvironment': any;
-    /** Secret files as JSON object, encrypted at rest. File path must be absolute Example: {"/dir/fileName":{"data":"VGhpcyBpcyBhbiBleGFtcGxlIHdpdGggYSB0ZW1wbGF0ZWQgJHtOT0RFX0VOVn0gdmFyaWFibGU=","encoding":"utf-8"}} */
-    'runtimeFiles'?: any;
-};
-/** Sets the runtime environment for the given service. */
-export declare class UpdateServiceRuntimeenvironmentEndpoint extends PostApiEndpoint<UpdateServiceRuntimeenvironmentRequest, UpdateServiceRuntimeenvironmentResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: UpdateServiceRuntimeenvironmentRequest) => string;
-    body: (payload: UpdateServiceRuntimeenvironmentRequest) => string;
-}

package/dist/esm/endpoints/update/template.d.ts

@@ -1,81 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type UpdateTemplateResult = {
-    /** ID of the template. Example: "example-template" */
-    'id': string;
-    /** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
-    'createdAt': string;
-    /** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
-    'updatedAt': string;
-    'content'?: {
-        /** Name of the template. Example: "Example Template" */
-        'name': string;
-        /** Description of the template. Example: "This is a sample template." */
-        'description'?: string;
-        /** The version of the Northflank API to run the template against. Example: "v1" */
-        'apiVersion': 'v1';
-        /** Details of the project the template will run in. */
-        'project': {
-            /** The ID of the project to use. */
-            'id': string;
-        } | {
-            /** Details about the project to create. */
-            'spec': {
-                /** The name of the project. Example: "New Project" */
-                'name': string;
-                /** The description of the project. Example: "This is a new project." */
-                'description'?: string;
-                /** The region the project will be hosted in. Example: "europe-west" */
-                'region'?: string;
-                /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
-                'clusterId'?: string;
-                /** The color of the project in the Northflank App. Example: "#EF233C" */
-                'color'?: string;
-            };
-        };
-        'spec': any;
-    };
-};
-export declare type UpdateTemplateCall = (opts: UpdateTemplateRequest) => Promise<ApiCallResponse<UpdateTemplateResult>>;
-export declare type UpdateTemplateRequest = {
-    parameters: UpdateTemplateParameters;
-    data: UpdateTemplateData;
-};
-export declare type UpdateTemplateParameters = {
-    /** ID of the template */ 'templateId': string;
-};
-export declare type UpdateTemplateData = {
-    /** Name of the template. Example: "Example Template" */
-    'name': string;
-    /** Description of the template. Example: "This is a sample template." */
-    'description'?: string;
-    /** The version of the Northflank API to run the template against. Example: "v1" */
-    'apiVersion': 'v1';
-    /** Details of the project the template will run in. */
-    'project': {
-        /** The ID of the project to use. */
-        'id': string;
-    } | {
-        /** Details about the project to create. */
-        'spec': {
-            /** The name of the project. Example: "New Project" */
-            'name': string;
-            /** The description of the project. Example: "This is a new project." */
-            'description'?: string;
-            /** The region the project will be hosted in. Example: "europe-west" */
-            'region'?: string;
-            /** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
-            'clusterId'?: string;
-            /** The color of the project in the Northflank App. Example: "#EF233C" */
-            'color'?: string;
-        };
-    };
-    'spec': any;
-};
-/** Update a template */
-export declare class UpdateTemplateEndpoint extends PostApiEndpoint<UpdateTemplateRequest, UpdateTemplateResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: UpdateTemplateRequest) => string;
-    body: (payload: UpdateTemplateRequest) => string;
-}

package/dist/esm/endpoints/update/volume.d.ts

@@ -1,33 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type UpdateVolumeResult = any;
-export declare type UpdateVolumeCall = (opts: UpdateVolumeRequest) => Promise<ApiCallResponse<UpdateVolumeResult>>;
-export declare type UpdateVolumeRequest = {
-    parameters: UpdateVolumeParameters;
-    data: UpdateVolumeData;
-};
-export declare type UpdateVolumeParameters = {
-    /** ID of the project */ 'projectId': string;
-    /** ID of the volume */
-    'volumeId': string;
-};
-export declare type UpdateVolumeData = {
-    /** Array of mounts, containerMountPaths must be unique */
-    'mounts'?: {
-        /** Optionally specify the path inside this volume that should be mounted */
-        'volumeMountPath'?: string;
-        /** Specify the path into which the volume should be mounted Example: "/container" */
-        'containerMountPath': string;
-    }[];
-    'spec'?: {
-        /** The size of the storage, in megabytes. Configurable sizes depend on the storage class. Example: 4096 */
-        'storageSize'?: number;
-    };
-};
-/** Update volume mounts and storage size */
-export declare class UpdateVolumeEndpoint extends PostApiEndpoint<UpdateVolumeRequest, UpdateVolumeResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: UpdateVolumeRequest) => string;
-    body: (payload: UpdateVolumeRequest) => string;
-}

package/dist/esm/endpoints/verify/domain.d.ts

@@ -1,17 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type VerifyDomainResult = any | any;
-export declare type VerifyDomainCall = (opts: VerifyDomainRequest) => Promise<ApiCallResponse<VerifyDomainResult>>;
-export declare type VerifyDomainRequest = {
-    parameters: VerifyDomainParameters;
-};
-export declare type VerifyDomainParameters = {
-    /** Name of the domain */ 'domain': string;
-};
-/** Attempts to verify the domain */
-export declare class VerifyDomainEndpoint extends PostApiEndpoint<VerifyDomainRequest, VerifyDomainResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: VerifyDomainRequest) => string;
-    body: () => undefined;
-}

package/dist/esm/endpoints/verify/subdomain.d.ts

@@ -1,19 +0,0 @@
-import { ApiCallResponse, PostApiEndpoint } from '../../api-endpoint';
-export declare type VerifySubdomainResult = any | any;
-export declare type VerifySubdomainCall = (opts: VerifySubdomainRequest) => Promise<ApiCallResponse<VerifySubdomainResult>>;
-export declare type VerifySubdomainRequest = {
-    parameters: VerifySubdomainParameters;
-};
-export declare type VerifySubdomainParameters = {
-    /** Name of the domain */ 'domain': string;
-    /** Name of the subdomain */
-    'subdomain': string;
-};
-/** Gets details about the given subdomain */
-export declare class VerifySubdomainEndpoint extends PostApiEndpoint<VerifySubdomainRequest, VerifySubdomainResult> {
-    description: string;
-    withAuth: boolean;
-    requiredPermissions: string;
-    endpointUrl: (opts: VerifySubdomainRequest) => string;
-    body: () => undefined;
-}

package/dist/esm/exec-command/client/exec-command-runner.d.ts

@@ -1,70 +0,0 @@
-import { ApiClientContextProvider } from '../../context';
-import { ExecCommandStandard } from './exec-command-standard';
-export { ExecCommandStandard };
-export declare type CommandResult = {
-    exitCode: number;
-    status: 'Success' | 'Failure' | 'Unknown';
-    message?: string;
-};
-export declare type ExecCommandData = {
-    command: string | string[];
-    containerName?: string;
-    shell?: string;
-    user?: string | number;
-    group?: string | number;
-};
-export declare type ExecSessionData = Omit<ExecCommandData, 'command'> & {
-    command?: string | string[];
-    ttyRows?: number;
-    ttyColumns?: number;
-};
-export declare class NorthflankExecCommand {
-    private readonly contextProvider;
-    constructor(contextProvider: ApiClientContextProvider);
-    /**
-     * Runs command on a Northflank service and waits for completion returning command result and
-     * standard output and standard error emitted during commmand execution.
-     */
-    execServiceCommand(parameters: {
-        projectId: string;
-        serviceId: string;
-    }, data: ExecCommandData): Promise<{
-        commandResult: CommandResult;
-        stdOut: string;
-        stdErr: string;
-    }>;
-    /**
-     * Starts a session on a Northflank service. This is usually a longer-running command. The returned object allows to listen to events as well
-     * as consume streams for standard output (stdOut) and standard error (stdErr). Input can be sent using the standard input (stdIn)
-     * writable stream.
-     */
-    execServiceSession(parameters: {
-        projectId: string;
-        serviceId: string;
-    }, data?: ExecSessionData): 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.
-     */
-    execJobCommand(parameters: {
-        projectId: string;
-        jobId: string;
-    }, data: ExecCommandData): Promise<{
-        commandResult: CommandResult;
-        stdOut: string;
-        stdErr: string;
-    }>;
-    /**
-     * Starts a session on a Northflank job. This is usually a longer-running command. The returned object allows to listen to events as well
-     * as consume streams for standard output (stdOut) and standard error (stdErr). Input can be sent using the standard input (stdIn)
-     * writable stream.
-     */
-    execJobSession(parameters: {
-        projectId: string;
-        jobId: string;
-    }, data?: ExecSessionData): Promise<ExecCommandStandard>;
-    private execCommand;
-    private shellSession;
-    private getCommandRunner;
-    private assertStartedWithNodejs;
-}

package/dist/esm/exec-command/client/exec-command-standard.d.ts

@@ -1,42 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import * as stream from 'stream';
-import { ExecCommand } from './exec-command';
-import { CommandResult } from './exec-command-runner';
-export declare type ExecConfig = {
-    projectId: string;
-    entityType: 'service' | 'job' | 'addon' | 'build';
-    entityId: string;
-    containerName?: string;
-    command?: string | string[];
-    shell?: string;
-    user?: string | number;
-    group?: string | number;
-    ttyRows?: number;
-    ttyColumns?: number;
-};
-export declare class ExecCommandStandard extends EventEmitter implements ExecCommand {
-    private readonly baseUrl;
-    readonly execConfig: ExecConfig;
-    private readonly token;
-    readonly stdOut: stream.PassThrough;
-    readonly stdErr: stream.PassThrough;
-    readonly stdIn: stream.PassThrough;
-    private remote;
-    private currentCommand;
-    private duplex;
-    constructor(baseUrl: string, execConfig: ExecConfig, token: string, // readonly timeout: number = 120 // Timeout in seconds
-    stdOut?: stream.PassThrough, stdErr?: stream.PassThrough, stdIn?: stream.PassThrough);
-    private get execEndpoint();
-    waitForCommandResult: () => Promise<CommandResult>;
-    sendInputToCurrentCommand: (input: string) => Promise<void>;
-    resizeTerminal: (size: {
-        rows?: number;
-        columns?: number;
-    }) => Promise<void>;
-    start(): Promise<CommandResult>;
-    private constructPayloadPacket;
-    private initialAuth;
-    private reset;
-}

package/dist/esm/port-forward/client/api-helper.d.ts

@@ -1,30 +0,0 @@
-import { ApiClientContextProvider } from '../../context';
-interface ServiceInfo {
-    targetDomain: string;
-    namespace: string;
-    instances: {
-        podName: string;
-    }[];
-    ports: PortInfo[];
-}
-interface AddonInfo {
-    targetDomain: string;
-    instances: {
-        podName: string;
-        internalHostname: string;
-        ports: PortInfo[];
-    }[];
-}
-export interface PortInfo {
-    name?: string;
-    internalPort: number;
-    protocol?: 'HTTP' | 'TCP' | 'UDP';
-}
-export declare class PortProxyApiClient {
-    private readonly contextProvider;
-    constructor(contextProvider: ApiClientContextProvider);
-    getServiceDetails(project: string, service: string): Promise<ServiceInfo>;
-    getAddonDetails(project: string, addon: string): Promise<AddonInfo>;
-    private fetch;
-}
-export {};

package/dist/esm/port-forward/client/atomic-write.d.ts

@@ -1,2 +0,0 @@
-import { WriteFileOptions } from 'fs';
-export declare const writeFile: (filePath: string, data: any, options?: WriteFileOptions) => Promise<void>;

package/dist/esm/port-forward/client/host-file-ast.d.ts

@@ -1,52 +0,0 @@
-export interface InvalidNode {
-    type: 'invalid';
-    line: string;
-}
-export interface EolNode {
-    type: 'eol';
-    line: string;
-}
-export interface BlankNode {
-    type: 'blank';
-    line: string;
-}
-export interface CommentNode {
-    type: 'comment';
-    line: string;
-}
-export interface EntryNode {
-    type: 'entry';
-    ipPrefixWhitespace: string;
-    ip: string;
-    hosts: {
-        whitespace: string;
-        host: string;
-    }[];
-}
-export declare type HostsFileNode = InvalidNode | EolNode | BlankNode | CommentNode | EntryNode;
-export interface HostsFileAstOptions {
-    eol: string;
-    indent: number;
-    ipPrefixWhitespace: string;
-}
-export declare class HostsFileAst {
-    private nodes;
-    private readonly config;
-    constructor(nodes: HostsFileNode[], config: HostsFileAstOptions);
-    add(ip: string, hosts: string[], header?: string): this;
-    remove(ip: string, hosts: string[]): this;
-    removeHosts(hosts: string[]): void;
-    removeIps(ips: string[]): this;
-    resolveHosts(ip: string): any;
-    resolveIps(host: string): string[];
-    toString(): string;
-    private removeEntry;
-    private findEntries;
-    private findOrCreateEntry;
-    private insertAt;
-    private makeEntry;
-    static fromNodes(nodes: HostsFileNode[], options?: Partial<HostsFileAstOptions>): HostsFileAst;
-    static parse(data: string, options?: Partial<HostsFileAstOptions>): HostsFileAst;
-}
-export declare const generateHostsFile: (nodes: HostsFileNode[], eol?: string) => string;
-export declare const parseHostsFile: (data: string) => HostsFileNode[];

package/dist/esm/port-forward/client/host-file.d.ts

@@ -1,26 +0,0 @@
-import { HostsFileAstOptions } from './host-file-ast';
-export declare type HostsFileOptions = Partial<HostsFileConfig>;
-export declare type HostsFileWriteMode = 'disabled' | 'atomic' | 'standard';
-export interface HostsFileConfig extends Partial<HostsFileAstOptions> {
-    writeMode: HostsFileWriteMode;
-    header?: string;
-    hostsFile: string;
-}
-export declare class HostsFile {
-    private readonly config;
-    private ast;
-    constructor(options?: HostsFileOptions);
-    add(ip: string, ...hosts: string[]): this;
-    remove(ip: string, ...hosts: string[]): this;
-    removeHosts(...hosts: string[]): this;
-    removeIps(...ips: string[]): this;
-    read(): Promise<this>;
-    write(options?: {
-        writeMode?: HostsFileWriteMode;
-    }): Promise<this>;
-    backup(options: {
-        suffix: string;
-        rewrite?: boolean;
-    }): Promise<void>;
-    static load(options?: HostsFileOptions): Promise<HostsFile>;
-}

package/dist/esm/port-forward/client/loopback.d.ts

@@ -1,4 +0,0 @@
-export declare const findAvailableLoopbackIp: (port: number, ipMinStr?: string, ipMaxStr?: string) => Promise<string>;
-export declare const isPortAvailableForIp: (port: number, ip?: string) => Promise<unknown>;
-export declare const ip2int: (ip: string) => number;
-export declare const int2ip: (int: number) => string;

package/dist/esm/port-forward/client/port-forwarder.d.ts

@@ -1,87 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { PortForwardingInfo, PortTunnel } from './port-tunnel';
-import { ApiClientContextProvider } from '../../context';
-import { ListServicesCall } from '../../endpoints/list/services';
-import { ListAddonsCall } from '../../endpoints/list/addons';
-export interface NorthflankPortForwarder {
-    on(event: 'connection-accept', listener: (tunnel: PortTunnel) => any): any;
-    on(event: 'connection-close', listener: (tunnel: PortTunnel) => any): any;
-    on(event: 'connection-error', listener: (tunnel: PortTunnel, data: PortForwardingInfo, error: any) => any): any;
-    on(event: 'tunnel-open', listener: (tunnel: PortTunnel, data: PortForwardingInfo) => any): any;
-    on(event: 'tunnel-close', listener: (tunnel: PortTunnel, data: PortForwardingInfo) => any): any;
-}
-export declare type PortForwardingResult = {
-    data: PortForwardingInfo;
-    error?: never;
-} | {
-    data?: never;
-    error: {
-        message: string;
-    };
-};
-export declare class NorthflankPortForwarder extends EventEmitter {
-    private readonly contextProvider;
-    private readonly listServices;
-    private readonly listAddons;
-    private nextIpAddress?;
-    private connections;
-    private proxyApiClient;
-    private hostsFileMutex;
-    private ipAllocationMutex;
-    constructor(contextProvider: ApiClientContextProvider, listServices: ListServicesCall, listAddons: ListAddonsCall);
-    withProjectForwarding<T = any>(parameters: {
-        projectId: string;
-    }, func: (p: {
-        services: PortForwardingResult[][];
-        addons: PortForwardingResult[][];
-    }) => Promise<T>, ipOnly?: boolean): Promise<T>;
-    forwardProject(parameters: {
-        projectId: string;
-    }, ipOnly?: boolean): Promise<{
-        services: PortForwardingResult[][];
-        addons: PortForwardingResult[][];
-    }>;
-    withServiceForwarding<T = any>(parameters: {
-        projectId: string;
-        serviceId: string;
-    }, func: (p: PortForwardingResult[]) => Promise<T>, ipOnly?: boolean): Promise<T>;
-    forwardService(parameters: {
-        projectId: string;
-        serviceId: string;
-    }, ipOnly?: boolean): Promise<PortForwardingResult[]>;
-    withAddonForwarding<T = any>(parameters: {
-        projectId: string;
-        addonId: string;
-    }, func: (p: PortForwardingResult[]) => Promise<T>, ipOnly?: boolean): Promise<T>;
-    forwardAddon(parameters: {
-        projectId: string;
-        addonId: string;
-    }, ipOnly?: boolean): Promise<PortForwardingResult[]>;
-    private allocateIpAddress;
-    private forwardPort;
-    private determineSocketAddress;
-    private registerHostnames;
-    private unregisterHostnames;
-    private modifyHostsFile;
-    stopProjectForwarding(opts: {
-        projectId: string;
-    }): Promise<void>;
-    stopServiceForwarding(opts: {
-        projectId: string;
-        serviceId: string;
-    }): Promise<void>;
-    stopAddonForwarding(opts: {
-        projectId: string;
-        addonId: string;
-    }): Promise<void>;
-    private stopForwarding;
-    stop(): Promise<void>;
-    canExecuteWithHostnames: () => {
-        error: boolean;
-        message?: string | undefined;
-        type?: "windows-admin" | "unix-admin" | undefined;
-    };
-    private assertStartedWithNodejs;
-}
-export declare const retry: (retries: number, retryDelay?: number) => (action: () => any) => Promise<any>;

package/dist/esm/port-forward/client/port-tunnel-tcp.d.ts

@@ -1,36 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { PortTunnel } from './port-tunnel';
-export declare class PortTunnelTcp extends EventEmitter implements PortTunnel {
-    private readonly endpoint;
-    private readonly headers;
-    private readonly rewriteHostHeader?;
-    private readonly bindToAssign?;
-    private readonly closeTimeout;
-    private readonly tcpServer;
-    readonly protocol = "TCP";
-    private readonly hostRegex;
-    private readonly openConnections;
-    private boundTo?;
-    constructor(endpoint: string, headers: {
-        [_: string]: string;
-    }, rewriteHostHeader?: {
-        altHostnames: string[];
-        targetHostname: string;
-    } | undefined, bindToAssign?: {
-        address: string;
-        port: number;
-    } | undefined, closeTimeout?: number);
-    get bindTo(): {
-        address: string;
-        port: number;
-    } | undefined;
-    open(): Promise<{
-        address: string;
-        port: number;
-    }>;
-    close(): Promise<void>;
-    private handleConnection;
-    /** rewrite host header which can lead to issues when request coming from a different hostname */
-    private getHeaderTransform;
-}