Module: main/session-manager

Session manager — the PuTTY-style session config & lifecycle for nero-terminal, in the main process.

Opens either a remote SSH session (SshHost / ssh2) or a local shell (PtyHost / node-pty); both implement the same host interface, so the same terminal-lib IPC bridge (attachPtyToIpc) serves either backend. Also detects local shells and persists "Saved Sessions" to userData/sessions.json.

Extracted from module:main/main so it can be exercised headlessly by scripts/session-smoke.js.

Methods

(inner) buildJumpList(execPath, profiles, iconPathopt) → {Array.<object>}

Build a Windows taskbar jump list from saved session profiles, for app.setJumpList(). Each entry relaunches the app with --open-profile="<name>" so the running instance opens that saved session. Returns an empty array when there are no profiles (which clears the list).

Parameters:

Name	Type	Attributes	Description
`execPath`	string		Path to the app executable (`process.execPath`).
`profiles`	Array.<SessionProfile>		Saved profiles to list.
`iconPath`	string	<optional>	Icon shown for each jump-list entry.

Returns:

Categories for app.setJumpList().

Type:: Array.<object>

(inner) createSessionManager(deps) → {SessionManager}

Create a session manager bound to a single window. Holds at most one live session (a host + its IPC bridge) at a time.

Parameters:

Name Type Description

deps

object

Properties

Name	Type	Attributes	Description
`app`	Electron.App		Used for `userData` (saved sessions path).
`ipcMain`	Electron.IpcMain		Where the handlers and the PTY bridge attach.
`dialog`	Electron.Dialog		For the directory / key-file pickers.
`getWindow`	function		Returns the target window.
`onProfilesChanged`	function	<optional>	Called with the new list whenever saved profiles change (to refresh the jump list).

Returns:

Type:: SessionManager

(inner) detectShells() → {Array.<ShellDescriptor>}

Detect the local shells available on this machine (for the "Local" connection type). On Windows: PowerShell, pwsh 7 (if present), Command Prompt, WSL (if present), Git Bash (if present). Elsewhere: $SHELL plus common alternatives.

Returns:

Type:: Array.<ShellDescriptor>

(inner) firstExisting(paths) → {string|null}

Return the first path in paths that exists, else null.

Parameters:

Name	Type	Description
`paths`	Array.<string>

Returns:

Type:: string | null

Type Definitions

SessionManager

The object returned by createSessionManager.

Type:

object

Properties

Name	Type	Description
`register`	function	Register all `session:` / `profiles:` IPC handlers.
`openSession`	function	Open a session directly (used by smokes).
`closeSession`	function	Dispose the active session.
`detectShells`	function
`loadProfiles`	function	Read the saved profiles.

SessionOptions

Options accepted by openSession (and window.sessionAPI.open).

Type:

object

Properties

Name	Type	Attributes	Default	Description
`type`	'ssh' \| 'local'	<optional>	'ssh'	Connection type.
`cols`	number	<optional>	120
`rows`	number	<optional>	32
`host`	string	<optional>		SSH: host name or IP.
`port`	number	<optional>	22	SSH: port.
`username`	string	<optional>		SSH: login user (else prompted in-terminal).
`password`	string	<optional>		SSH: password (else prompted in-terminal).
`keyPath`	string	<optional>		SSH: path to a private key file, read by main.
`passphrase`	string	<optional>		SSH: key passphrase.
`term`	string	<optional>	'xterm-256color'	SSH: TERM string.
`shell`	string	<optional>		Local: executable to spawn.
`args`	Array.<string>	<optional>		Local: shell arguments.
`cwd`	string	<optional>		Local: working directory (defaults to home).
`env`	Object.<string, string>	<optional>		Local: extra environment variables.

SessionProfile

A saved session (PuTTY "Saved Sessions"). A superset of SessionOptions plus presentation fields; secrets (password, passphrase) are never persisted.

Type:

object

Properties

Name	Type	Attributes
`name`	string
`type`	'ssh' \| 'local'
`host`	string	<optional>
`port`	number	<optional>
`username`	string	<optional>
`keyPath`	string	<optional>
`shellId`	string	<optional>
`cols`	number	<optional>
`rows`	number	<optional>
`scrollback`	number	<optional>
`fontFamily`	string	<optional>
`fontSize`	number	<optional>
`theme`	string	<optional>

SessionResult

Result of openSession.

Type:

object

Properties

Name	Type	Description
`pid`	number \| null	OS process id for a local PTY; `null` for SSH.
`type`	'ssh' \| 'local'	The connection type that was opened.

ShellDescriptor

A local shell offered under the "Local" connection type.

Type:

object

Properties

Name	Type	Description
`id`	string	Stable identifier (e.g. `'powershell'`, `'wsl'`, `'gitbash'`).
`label`	string	Human-readable name shown in the dropdown.
`shell`	string	Executable to spawn.
`args`	Array.<string>	Default arguments for that shell.