@tailscale/connect/pkg.d.ts

Tailscale Connect SDK

import { ITerminalOptions } from 'xterm';

declare global {
	function newIPN(config: IPNConfig): IPN;
	interface IPN {
		run(callbacks: IPNCallbacks): void;
		login(): void;
		logout(): void;
		ssh(host: string, username: string, termConfig: {
			writeFn: (data: string) => void;
			writeErrorFn: (err: string) => void;
			setReadFn: (readFn: (data: string) => void) => void;
			rows: number;
			cols: number;
			/** Defaults to 5 seconds */
			timeoutSeconds?: number;
			onConnectionProgress: (message: string) => void;
			onConnected: () => void;
			onDone: () => void;
		}): IPNSSHSession;
		fetch(url: string): Promise<{
			status: number;
			statusText: string;
			text: () => Promise<string>;
		}>;
	}
	interface IPNSSHSession {
		resize(rows: number, cols: number): boolean;
		close(): boolean;
	}
	interface IPNStateStorage {
		setState(id: string, value: string): void;
		getState(id: string): string;
	}
	type IPNConfig = {
		stateStorage?: IPNStateStorage;
		authKey?: string;
		controlURL?: string;
		hostname?: string;
	};
	type IPNCallbacks = {
		notifyState: (state: IPNState) => void;
		notifyNetMap: (netMapStr: string) => void;
		notifyBrowseToURL: (url: string) => void;
		notifyPanicRecover: (err: string) => void;
	};
	type IPNNetMap = {
		self: IPNNetMapSelfNode;
		peers: IPNNetMapPeerNode[];
		lockedOut: boolean;
	};
	type IPNNetMapNode = {
		name: string;
		addresses: string[];
		machineKey: string;
		nodeKey: string;
	};
	type IPNNetMapSelfNode = IPNNetMapNode & {
		machineStatus: IPNMachineStatus;
	};
	type IPNNetMapPeerNode = IPNNetMapNode & {
		online?: boolean;
		tailscaleSSHEnabled: boolean;
	};
	/** Mirrors values from ipn/backend.go */
	type IPNState = "NoState" | "InUseOtherUser" | "NeedsLogin" | "NeedsMachineAuth" | "Stopped" | "Starting" | "Running";
	/** Mirrors values from MachineStatus in tailcfg.go */
	type IPNMachineStatus = "MachineUnknown" | "MachineUnauthorized" | "MachineAuthorized" | "MachineInvalid";
}
export declare type SSHSessionDef = {
	username: string;
	hostname: string;
	/** Defaults to 5 seconds */
	timeoutSeconds?: number;
};
export declare type SSHSessionCallbacks = {
	onConnectionProgress: (messsage: string) => void;
	onConnected: () => void;
	onDone: () => void;
	onError?: (err: string) => void;
};
export declare function runSSHSession(termContainerNode: HTMLDivElement, def: SSHSessionDef, ipn: IPN, callbacks: SSHSessionCallbacks, terminalOptions?: ITerminalOptions): void;
/**
 * Superset of the IPNConfig type, with additional configuration that is
 * needed for the package to function.
 */
export declare type IPNPackageConfig = IPNConfig & {
	authKey: string;
	wasmURL?: string;
	panicHandler: (err: string) => void;
};
export declare function createIPN(config: IPNPackageConfig): Promise<IPN>;

export {};