feat: allow to ssh to podman virtual machine - api.d.ts changes

[gastoner]

What does this PR do?

Provide the ability to ssh to podman machine - api.d.ts changes
1/4 PR's
-Needs to be merged first

Screenshot / video of UI

Screen.Recording.2024-10-15.145316.mp4

What issues does this PR fix or reference?

Part of #889

How to test this PR?

Create a podman machine, open terminal

• Tests are covering the bug fix or the new feature

[benoitf]

you should add some sample/typedoc

also I don't understand starConnection and stopConnection

setWindow should be maybe resize

[gastoner]

you should add some sample/typedoc

also I don't understand starConnection and stopConnection

setWindow should be maybe resize

The start/stop is used in stop ssh connection at first if there is any/ or to start the connection when are all callbacks set

The resize is used in container terminal and the ssh2 lib uses setWindow, so I wanted to stick with ssh2 lib theme

[benoitf]

I think the API might be hard to understand if you still use ssh2 method as setWindow means nothing here, so please use resize as we're resizing

Then I'm not sure the on callback should be there if you follow that approach of having also "start and stop"

because the on callback and write are useless if you're not connected as they're tied to a connection/session

it means, from API POV, the events and method to interact with a session should only be part of the result of the start()

And from what I see, it's more to connect/disconnect than start and stop

or open and close

so maybe it's connect() method that gives you an object and on this object you have the on('data', 'error', 'end') events and the write method and the disconnect and the resize

also please remove any mention of 'ssh connection' as it's up to the implementation to see how it connects. API is not relying on ssh

[benoitf]

I'm not sure that write is with string parameter, maybe it could also be Uint8Array

[benoitf]

you might add samples with @example

[axel7083]

How can I test as you are doing in the video, which branches should I combined with this PR ?

[gastoner]

@axel7083 all changes are in https://github.com/gastoner/podman-desktop/tree/provide_ability_to_easily_get_a_shell_in_a_machine_test branch

Otherwise there is a provide_ability_to_easily_get_a_shell_in_a_machine + "a"/"b"/"c" branches (4 total)

[axel7083]

LGTM