mirror of
https://github.com/binaricat/Netcatty.git
synced 2026-11-21 23:50:45 +00:00
Adds a splash screen with fade-out animation for smoother startup and reduces initial blank window time in production. Implements robust cross-window settings synchronization via IPC, ensuring changes propagate instantly across all open windows. Optimizes settings persistence, theme/color validation, and settings change notifications. Refactors Electron protocol handling for more secure, maintainable app resource serving. Enhances chunk splitting strategy for faster initial load and better caching.
336 lines
11 KiB
TypeScript
336 lines
11 KiB
TypeScript
import type { RemoteFile } from "./types";
|
|
|
|
declare global {
|
|
// Proxy configuration for SSH connections
|
|
interface NetcattyProxyConfig {
|
|
type: 'http' | 'socks5';
|
|
host: string;
|
|
port: number;
|
|
username?: string;
|
|
password?: string;
|
|
}
|
|
|
|
// Jump host configuration for SSH tunneling
|
|
interface NetcattyJumpHost {
|
|
hostname: string;
|
|
port: number;
|
|
username: string;
|
|
password?: string;
|
|
privateKey?: string;
|
|
certificate?: string;
|
|
passphrase?: string;
|
|
publicKey?: string;
|
|
keyId?: string;
|
|
keySource?: 'generated' | 'imported';
|
|
label?: string; // Display label for UI
|
|
}
|
|
|
|
// Host key information for verification
|
|
// Reserved for future host key verification UI feature
|
|
interface _NetcattyHostKeyInfo {
|
|
hostname: string;
|
|
port: number;
|
|
keyType: string;
|
|
fingerprint: string;
|
|
publicKey?: string;
|
|
}
|
|
|
|
interface NetcattySSHOptions {
|
|
sessionId?: string;
|
|
hostname: string;
|
|
username: string;
|
|
port?: number;
|
|
password?: string;
|
|
privateKey?: string;
|
|
// Optional OpenSSH user certificate
|
|
certificate?: string;
|
|
publicKey?: string; // OpenSSH public key line
|
|
keyId?: string;
|
|
keySource?: 'generated' | 'imported';
|
|
agentForwarding?: boolean;
|
|
cols?: number;
|
|
rows?: number;
|
|
charset?: string;
|
|
extraArgs?: string[];
|
|
startupCommand?: string;
|
|
passphrase?: string;
|
|
// Environment variables to set in the remote shell
|
|
env?: Record<string, string>;
|
|
// Proxy configuration
|
|
proxy?: NetcattyProxyConfig;
|
|
// Jump hosts (bastion chain)
|
|
jumpHosts?: NetcattyJumpHost[];
|
|
}
|
|
|
|
interface SftpStatResult {
|
|
name: string;
|
|
type: 'file' | 'directory' | 'symlink';
|
|
size: number;
|
|
lastModified: number; // timestamp
|
|
permissions?: string; // e.g., "rwxr-xr-x"
|
|
owner?: string;
|
|
group?: string;
|
|
}
|
|
|
|
interface SftpTransferProgress {
|
|
transferId: string;
|
|
bytesTransferred: number;
|
|
totalBytes: number;
|
|
speed: number; // bytes per second
|
|
}
|
|
|
|
// Port Forwarding Types
|
|
interface PortForwardOptions {
|
|
tunnelId: string;
|
|
type: 'local' | 'remote' | 'dynamic';
|
|
localPort: number;
|
|
bindAddress?: string;
|
|
remoteHost?: string;
|
|
remotePort?: number;
|
|
// SSH connection details
|
|
hostname: string;
|
|
port?: number;
|
|
username: string;
|
|
password?: string;
|
|
privateKey?: string;
|
|
}
|
|
|
|
interface PortForwardResult {
|
|
tunnelId: string;
|
|
success: boolean;
|
|
error?: string;
|
|
}
|
|
|
|
interface PortForwardStatusResult {
|
|
tunnelId: string;
|
|
status: 'inactive' | 'connecting' | 'active' | 'error';
|
|
type?: 'local' | 'remote' | 'dynamic';
|
|
error?: string;
|
|
}
|
|
|
|
type PortForwardStatusCallback = (status: 'inactive' | 'connecting' | 'active' | 'error', error?: string) => void;
|
|
|
|
interface NetcattyBridge {
|
|
startSSHSession(options: NetcattySSHOptions): Promise<string>;
|
|
startTelnetSession?(options: {
|
|
sessionId?: string;
|
|
hostname: string;
|
|
port?: number;
|
|
cols?: number;
|
|
rows?: number;
|
|
charset?: string;
|
|
env?: Record<string, string>;
|
|
}): Promise<string>;
|
|
startMoshSession?(options: {
|
|
sessionId?: string;
|
|
hostname: string;
|
|
username?: string;
|
|
port?: number;
|
|
moshServerPath?: string;
|
|
agentForwarding?: boolean;
|
|
cols?: number;
|
|
rows?: number;
|
|
charset?: string;
|
|
env?: Record<string, string>;
|
|
}): Promise<string>;
|
|
startLocalSession?(options: { sessionId?: string; cols?: number; rows?: number; shell?: string; env?: Record<string, string> }): Promise<string>;
|
|
generateKeyPair?(options: {
|
|
type: 'RSA' | 'ECDSA' | 'ED25519';
|
|
bits?: number;
|
|
comment?: string;
|
|
}): Promise<{ success: boolean; privateKey?: string; publicKey?: string; error?: string }>;
|
|
execCommand(options: {
|
|
hostname: string;
|
|
username: string;
|
|
port?: number;
|
|
password?: string;
|
|
privateKey?: string;
|
|
command: string;
|
|
timeout?: number;
|
|
}): Promise<{ stdout: string; stderr: string; code: number | null }>;
|
|
writeToSession(sessionId: string, data: string): void;
|
|
resizeSession(sessionId: string, cols: number, rows: number): void;
|
|
closeSession(sessionId: string): void;
|
|
onSessionData(sessionId: string, cb: (data: string) => void): () => void;
|
|
onSessionExit(
|
|
sessionId: string,
|
|
cb: (evt: { exitCode?: number; signal?: number }) => void
|
|
): () => void;
|
|
onAuthFailed?(
|
|
sessionId: string,
|
|
cb: (evt: { sessionId: string; error: string; hostname: string }) => void
|
|
): () => void;
|
|
|
|
// SFTP operations
|
|
openSftp(options: NetcattySSHOptions): Promise<string>;
|
|
listSftp(sftpId: string, path: string): Promise<RemoteFile[]>;
|
|
readSftp(sftpId: string, path: string): Promise<string>;
|
|
readSftpBinary?(sftpId: string, path: string): Promise<ArrayBuffer>;
|
|
writeSftp(sftpId: string, path: string, content: string): Promise<void>;
|
|
writeSftpBinary?(sftpId: string, path: string, content: ArrayBuffer): Promise<void>;
|
|
closeSftp(sftpId: string): Promise<void>;
|
|
mkdirSftp(sftpId: string, path: string): Promise<void>;
|
|
deleteSftp?(sftpId: string, path: string): Promise<void>;
|
|
renameSftp?(sftpId: string, oldPath: string, newPath: string): Promise<void>;
|
|
statSftp?(sftpId: string, path: string): Promise<SftpStatResult>;
|
|
chmodSftp?(sftpId: string, path: string, mode: string): Promise<void>;
|
|
|
|
// Write binary with real-time progress callback
|
|
writeSftpBinaryWithProgress?(
|
|
sftpId: string,
|
|
path: string,
|
|
content: ArrayBuffer,
|
|
transferId: string,
|
|
onProgress?: (transferred: number, total: number, speed: number) => void,
|
|
onComplete?: () => void,
|
|
onError?: (error: string) => void
|
|
): Promise<{ success: boolean; transferId: string }>;
|
|
|
|
// Transfer with progress
|
|
uploadFile?(sftpId: string, localPath: string, remotePath: string, transferId: string): Promise<void>;
|
|
downloadFile?(sftpId: string, remotePath: string, localPath: string, transferId: string): Promise<void>;
|
|
cancelTransfer?(transferId: string): Promise<void>;
|
|
onTransferProgress?(transferId: string, cb: (progress: SftpTransferProgress) => void): () => void;
|
|
|
|
// Streaming transfer with real progress and cancellation
|
|
startStreamTransfer?(
|
|
options: {
|
|
transferId: string;
|
|
sourcePath: string;
|
|
targetPath: string;
|
|
sourceType: 'local' | 'sftp';
|
|
targetType: 'local' | 'sftp';
|
|
sourceSftpId?: string;
|
|
targetSftpId?: string;
|
|
totalBytes?: number;
|
|
},
|
|
onProgress?: (transferred: number, total: number, speed: number) => void,
|
|
onComplete?: () => void,
|
|
onError?: (error: string) => void
|
|
): Promise<{ transferId: string; totalBytes?: number; error?: string }>;
|
|
|
|
// Local filesystem operations
|
|
listLocalDir?(path: string): Promise<RemoteFile[]>;
|
|
readLocalFile?(path: string): Promise<ArrayBuffer>;
|
|
writeLocalFile?(path: string, content: ArrayBuffer): Promise<void>;
|
|
deleteLocalFile?(path: string): Promise<void>;
|
|
renameLocalFile?(oldPath: string, newPath: string): Promise<void>;
|
|
mkdirLocal?(path: string): Promise<void>;
|
|
statLocal?(path: string): Promise<SftpStatResult>;
|
|
getHomeDir?(): Promise<string>;
|
|
getSystemInfo?(): Promise<{ username: string; hostname: string }>;
|
|
|
|
setTheme?(theme: 'light' | 'dark'): Promise<boolean>;
|
|
setLanguage?(language: string): Promise<boolean>;
|
|
// Window controls for custom title bar (Windows/Linux)
|
|
windowMinimize?(): Promise<void>;
|
|
windowMaximize?(): Promise<boolean>;
|
|
windowClose?(): Promise<void>;
|
|
windowIsMaximized?(): Promise<boolean>;
|
|
|
|
// Settings window
|
|
openSettingsWindow?(): Promise<boolean>;
|
|
closeSettingsWindow?(): Promise<void>;
|
|
|
|
// Cross-window settings sync
|
|
notifySettingsChanged?(payload: { key: string; value: unknown }): void;
|
|
onSettingsChanged?(cb: (payload: { key: string; value: unknown }) => void): () => void;
|
|
|
|
// Cloud sync master password (stored in-memory + persisted via Electron safeStorage)
|
|
cloudSyncSetSessionPassword?(password: string): Promise<boolean>;
|
|
cloudSyncGetSessionPassword?(): Promise<string | null>;
|
|
cloudSyncClearSessionPassword?(): Promise<boolean>;
|
|
|
|
// Port Forwarding
|
|
startPortForward?(options: PortForwardOptions): Promise<PortForwardResult>;
|
|
stopPortForward?(tunnelId: string): Promise<PortForwardResult>;
|
|
getPortForwardStatus?(tunnelId: string): Promise<PortForwardStatusResult>;
|
|
listPortForwards?(): Promise<{ tunnelId: string; type: string; status: string }[]>;
|
|
onPortForwardStatus?(tunnelId: string, cb: PortForwardStatusCallback): () => void;
|
|
|
|
// Known Hosts
|
|
readKnownHosts?(): Promise<string | null>;
|
|
|
|
// Open URL in default browser
|
|
openExternal?(url: string): Promise<void>;
|
|
|
|
// App info (name/version/platform) for About screens
|
|
getAppInfo?(): Promise<{ name: string; version: string; platform: string }>;
|
|
|
|
// Notify main process the renderer has mounted/painted (used to avoid initial blank screen).
|
|
rendererReady?(): void;
|
|
|
|
onLanguageChanged?(cb: (language: string) => void): () => void;
|
|
|
|
// Chain progress listener for jump host connections
|
|
// Callback receives: (currentHop: number, totalHops: number, hostLabel: string, status: string)
|
|
onChainProgress?(cb: (hop: number, total: number, label: string, status: string) => void): () => void;
|
|
|
|
// OAuth callback server for cloud sync
|
|
startOAuthCallback?(expectedState?: string): Promise<{ code: string; state?: string }>;
|
|
cancelOAuthCallback?(): Promise<void>;
|
|
|
|
// GitHub Device Flow (cloud sync)
|
|
githubStartDeviceFlow?(options?: { clientId?: string; scope?: string }): Promise<{
|
|
deviceCode: string;
|
|
userCode: string;
|
|
verificationUri: string;
|
|
expiresAt: number;
|
|
interval: number;
|
|
}>;
|
|
githubPollDeviceFlowToken?(options: { clientId?: string; deviceCode: string }): Promise<{
|
|
access_token?: string;
|
|
token_type?: string;
|
|
scope?: string;
|
|
error?: string;
|
|
error_description?: string;
|
|
}>;
|
|
|
|
// Google OAuth (cloud sync) - proxied via main process to avoid CORS
|
|
googleExchangeCodeForTokens?(options: {
|
|
clientId: string;
|
|
clientSecret?: string;
|
|
code: string;
|
|
codeVerifier: string;
|
|
redirectUri: string;
|
|
}): Promise<{
|
|
accessToken: string;
|
|
refreshToken?: string;
|
|
expiresAt?: number;
|
|
tokenType: string;
|
|
scope?: string;
|
|
}>;
|
|
googleRefreshAccessToken?(options: {
|
|
clientId: string;
|
|
clientSecret?: string;
|
|
refreshToken: string;
|
|
}): Promise<{
|
|
accessToken: string;
|
|
refreshToken: string;
|
|
expiresAt?: number;
|
|
tokenType: string;
|
|
scope?: string;
|
|
}>;
|
|
googleGetUserInfo?(options: { accessToken: string }): Promise<{
|
|
id: string;
|
|
email: string;
|
|
name: string;
|
|
picture?: string;
|
|
}>;
|
|
|
|
// Google Drive API (cloud sync) - proxied via main process to avoid CORS/COEP issues
|
|
googleDriveFindSyncFile?(options: { accessToken: string; fileName?: string }): Promise<{ fileId: string | null }>;
|
|
googleDriveCreateSyncFile?(options: { accessToken: string; fileName?: string; syncedFile: unknown }): Promise<{ fileId: string }>;
|
|
googleDriveUpdateSyncFile?(options: { accessToken: string; fileId: string; syncedFile: unknown }): Promise<{ ok: true }>;
|
|
googleDriveDownloadSyncFile?(options: { accessToken: string; fileId: string }): Promise<{ syncedFile: unknown | null }>;
|
|
googleDriveDeleteSyncFile?(options: { accessToken: string; fileId: string }): Promise<{ ok: true }>;
|
|
}
|
|
|
|
interface Window {
|
|
netcatty?: NetcattyBridge;
|
|
}
|
|
|
|
}
|
|
|
|
export { };
|