/
terminal.ts
218 lines (185 loc) · 4.89 KB
/
terminal.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { JSONPrimitive } from '@lumino/coreutils';
import { IObservableDisposable } from '@lumino/disposable';
import { ISignal } from '@lumino/signaling';
import { ServerConnection } from '..';
import { IManager as IBaseManager } from '../basemanager';
import { IModel, isAvailable } from './restapi';
export { IModel, isAvailable };
export namespace ITerminal {
export interface IOptions {
/**
* The terminal name.
*/
name?: string;
/**
* The terminal current directory.
*/
cwd?: string;
}
}
/**
* An interface for a terminal session.
*/
export interface ITerminalConnection extends IObservableDisposable {
/**
* A signal emitted when a message is received from the server.
*/
messageReceived: ISignal<ITerminalConnection, IMessage>;
/**
* Get the name of the terminal session.
*/
readonly name: string;
/**
* The model associated with the session.
*/
readonly model: IModel;
/**
* The server settings for the session.
*/
readonly serverSettings: ServerConnection.ISettings;
/**
* The current connection status of the terminal.
*/
readonly connectionStatus: ConnectionStatus;
/**
* A signal emitted when the terminal connection status changes.
*/
connectionStatusChanged: ISignal<this, ConnectionStatus>;
/**
* Send a message to the terminal session.
*/
send(message: IMessage): void;
/**
* Reconnect to the terminal.
*
* @returns A promise that resolves when the terminal has reconnected.
*/
reconnect(): Promise<void>;
/**
* Shut down the terminal session.
*/
shutdown(): Promise<void>;
}
export namespace ITerminalConnection {
export interface IOptions {
/**
* Terminal model.
*/
model: IModel;
/**
* The server settings.
*/
serverSettings?: ServerConnection.ISettings;
}
}
/**
* A message from the terminal session.
*/
export interface IMessage {
/**
* The type of the message.
*/
readonly type: MessageType;
/**
* The content of the message.
*/
readonly content?: JSONPrimitive[];
}
/**
* Valid message types for the terminal.
*/
export type MessageType = 'stdout' | 'disconnect' | 'set_size' | 'stdin';
/**
* The interface for a terminal manager.
*
* #### Notes
* The manager is responsible for maintaining the state of running
* terminal sessions.
*/
export interface IManager extends IBaseManager {
/**
* A signal emitted when the running terminals change.
*/
runningChanged: ISignal<IManager, IModel[]>;
/**
* A signal emitted when there is a connection failure.
*/
connectionFailure: ISignal<IManager, ServerConnection.NetworkError>;
/**
* Test whether the manager is ready.
*/
readonly isReady: boolean;
/**
* A promise that fulfills when the manager is ready.
*/
readonly ready: Promise<void>;
/**
* Whether the terminal service is available.
*/
isAvailable(): boolean;
/**
* Create an iterator over the known running terminals.
*
* @returns A new iterator over the running terminals.
*/
running(): IterableIterator<IModel>;
/**
* Create a new terminal session.
*
* @param options - The options used to create the terminal.
*
* @returns A promise that resolves with the terminal connection instance.
*
* #### Notes
* The manager `serverSettings` will be always be used.
*/
startNew(options?: ITerminal.IOptions): Promise<ITerminalConnection>;
/*
* Connect to a running session.
*
* @param options - The options used to connect to the terminal.
*
* @returns The new terminal connection instance.
*/
connectTo(
options: Omit<ITerminalConnection.IOptions, 'serverSettings'>
): ITerminalConnection;
/**
* Shut down a terminal session by name.
*
* @param name - The name of the terminal session.
*
* @returns A promise that resolves when the session is shut down.
*/
shutdown(name: string): Promise<void>;
/**
* Shut down all terminal sessions.
*
* @returns A promise that resolves when all of the sessions are shut down.
*/
shutdownAll(): Promise<void>;
/**
* Force a refresh of the running terminal sessions.
*
* @returns A promise that with the list of running sessions.
*
* #### Notes
* This is not typically meant to be called by the user, since the
* manager maintains its own internal state.
*/
refreshRunning(): Promise<void>;
}
/**
* The valid terminal connection states.
*
* #### Notes
* The status states are:
* * `connected`: The terminal connection is live.
* * `connecting`: The terminal connection is not live, but we are attempting
* to reconnect to the terminal.
* * `disconnected`: The terminal connection is down, we are not
* trying to reconnect.
*/
export type ConnectionStatus = 'connected' | 'connecting' | 'disconnected';