x-shell.js 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/README.md +304 -0
  2. package/dist/client/browser-bundle.js +314 -0
  3. package/dist/client/browser-bundle.js.map +7 -0
  4. package/dist/client/index.d.ts +7 -0
  5. package/dist/client/index.d.ts.map +1 -0
  6. package/dist/client/index.js +5 -0
  7. package/dist/client/index.js.map +1 -0
  8. package/dist/client/terminal-client.d.ts +122 -0
  9. package/dist/client/terminal-client.d.ts.map +1 -0
  10. package/dist/client/terminal-client.js +328 -0
  11. package/dist/client/terminal-client.js.map +1 -0
  12. package/dist/server/index.d.ts +7 -0
  13. package/dist/server/index.d.ts.map +1 -0
  14. package/dist/server/index.js +5 -0
  15. package/dist/server/index.js.map +1 -0
  16. package/dist/server/terminal-server.d.ts +107 -0
  17. package/dist/server/terminal-server.d.ts.map +1 -0
  18. package/dist/server/terminal-server.js +392 -0
  19. package/dist/server/terminal-server.js.map +1 -0
  20. package/dist/shared/types.d.ts +133 -0
  21. package/dist/shared/types.d.ts.map +1 -0
  22. package/dist/shared/types.js +5 -0
  23. package/dist/shared/types.js.map +1 -0
  24. package/dist/ui/browser-bundle.js +1654 -0
  25. package/dist/ui/browser-bundle.js.map +7 -0
  26. package/dist/ui/index.d.ts +6 -0
  27. package/dist/ui/index.d.ts.map +1 -0
  28. package/dist/ui/index.js +6 -0
  29. package/dist/ui/index.js.map +1 -0
  30. package/dist/ui/styles.d.ts +16 -0
  31. package/dist/ui/styles.d.ts.map +1 -0
  32. package/dist/ui/styles.js +125 -0
  33. package/dist/ui/styles.js.map +1 -0
  34. package/dist/ui/x-shell-terminal.d.ts +100 -0
  35. package/dist/ui/x-shell-terminal.d.ts.map +1 -0
  36. package/dist/ui/x-shell-terminal.js +540 -0
  37. package/dist/ui/x-shell-terminal.js.map +1 -0
  38. package/package.json +94 -0
package/README.md ADDED
@@ -0,0 +1,304 @@
1
+ # x-shell.js
2
+
3
+ > WebSocket-based terminal for Node.js - the truth is in your shell
4
+
5
+ A plug-and-play terminal solution for web applications. Includes a server component (node-pty), client library, and ready-to-use Lit web component.
6
+
7
+ ## Features
8
+
9
+ - **Server**: WebSocket server with node-pty for real shell sessions
10
+ - **Client**: Lightweight WebSocket client with auto-reconnection
11
+ - **UI**: `<x-shell-terminal>` Lit web component with xterm.js
12
+ - **Themes**: Built-in dark/light/auto theme support
13
+ - **Security**: Configurable shell and path allowlists
14
+ - **Framework Agnostic**: Works with React, Vue, Angular, Svelte, or vanilla JS
15
+
16
+ ## Installation
17
+
18
+ ```bash
19
+ npm install x-shell.js node-pty
20
+ ```
21
+
22
+ Note: `node-pty` requires native compilation. See [node-pty docs](https://github.com/microsoft/node-pty) for platform-specific requirements.
23
+
24
+ ## Quick Start
25
+
26
+ ### Server Setup
27
+
28
+ ```javascript
29
+ import express from 'express';
30
+ import { createServer } from 'http';
31
+ import { TerminalServer } from 'x-shell.js/server';
32
+
33
+ const app = express();
34
+ const server = createServer(app);
35
+
36
+ // Create and attach terminal server
37
+ const terminalServer = new TerminalServer({
38
+ allowedShells: ['/bin/bash', '/bin/zsh'],
39
+ allowedPaths: ['/home/user'],
40
+ defaultCwd: '/home/user',
41
+ verbose: true,
42
+ });
43
+
44
+ terminalServer.attach(server);
45
+
46
+ server.listen(3000, () => {
47
+ console.log('Server running on http://localhost:3000');
48
+ });
49
+ ```
50
+
51
+ ### Client Usage (Web Component)
52
+
53
+ ```html
54
+ <!-- Load xterm.js CSS -->
55
+ <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/xterm@5.3.0/css/xterm.css">
56
+
57
+ <!-- Load x-shell.js UI bundle -->
58
+ <script type="module" src="https://unpkg.com/x-shell.js/dist/ui/browser-bundle.js"></script>
59
+
60
+ <!-- Use the component -->
61
+ <x-shell-terminal
62
+ url="ws://localhost:3000/terminal"
63
+ theme="dark"
64
+ auto-connect
65
+ auto-spawn
66
+ ></x-shell-terminal>
67
+ ```
68
+
69
+ ### Client Usage (JavaScript)
70
+
71
+ ```javascript
72
+ import { TerminalClient } from 'x-shell.js/client';
73
+
74
+ const client = new TerminalClient({
75
+ url: 'ws://localhost:3000/terminal'
76
+ });
77
+
78
+ await client.connect();
79
+
80
+ client.onData((data) => {
81
+ console.log('Output:', data);
82
+ });
83
+
84
+ client.onExit((code) => {
85
+ console.log('Exited with code:', code);
86
+ });
87
+
88
+ await client.spawn({
89
+ shell: '/bin/bash',
90
+ cwd: '/home/user'
91
+ });
92
+
93
+ client.write('ls -la\n');
94
+ client.resize(120, 40);
95
+ ```
96
+
97
+ ## API Reference
98
+
99
+ ### Server
100
+
101
+ #### `TerminalServer`
102
+
103
+ ```typescript
104
+ import { TerminalServer } from 'x-shell.js/server';
105
+
106
+ const server = new TerminalServer({
107
+ // Allowed shells (empty = all allowed)
108
+ allowedShells: ['/bin/bash', '/bin/zsh', 'cmd.exe'],
109
+
110
+ // Allowed working directories (empty = all allowed)
111
+ allowedPaths: ['/home/user', '/var/www'],
112
+
113
+ // Default shell if not specified
114
+ defaultShell: '/bin/bash',
115
+
116
+ // Default working directory
117
+ defaultCwd: '/home/user',
118
+
119
+ // Max sessions per client (default: 5)
120
+ maxSessionsPerClient: 5,
121
+
122
+ // Idle timeout in ms (default: 30 minutes, 0 = disabled)
123
+ idleTimeout: 30 * 60 * 1000,
124
+
125
+ // WebSocket path (default: '/terminal')
126
+ path: '/terminal',
127
+
128
+ // Enable verbose logging
129
+ verbose: false,
130
+ });
131
+
132
+ // Attach to HTTP server
133
+ server.attach(httpServer);
134
+
135
+ // Or start standalone
136
+ server.listen(3001);
137
+
138
+ // Get active sessions
139
+ const sessions = server.getSessions();
140
+
141
+ // Close server
142
+ server.close();
143
+ ```
144
+
145
+ ### Client
146
+
147
+ #### `TerminalClient`
148
+
149
+ ```typescript
150
+ import { TerminalClient } from 'x-shell.js/client';
151
+
152
+ const client = new TerminalClient({
153
+ url: 'ws://localhost:3000/terminal',
154
+ reconnect: true, // Auto-reconnect (default: true)
155
+ maxReconnectAttempts: 10, // Max attempts (default: 10)
156
+ reconnectDelay: 1000, // Initial delay ms (default: 1000)
157
+ });
158
+
159
+ // Connect to server
160
+ await client.connect();
161
+
162
+ // Spawn terminal session
163
+ const sessionInfo = await client.spawn({
164
+ shell: '/bin/bash',
165
+ cwd: '/home/user',
166
+ env: { TERM: 'xterm-256color' },
167
+ cols: 80,
168
+ rows: 24,
169
+ });
170
+
171
+ // Write to terminal
172
+ client.write('echo "Hello World"\n');
173
+
174
+ // Resize terminal
175
+ client.resize(120, 40);
176
+
177
+ // Kill session
178
+ client.kill();
179
+
180
+ // Disconnect
181
+ client.disconnect();
182
+
183
+ // Event handlers
184
+ client.onConnect(() => console.log('Connected'));
185
+ client.onDisconnect(() => console.log('Disconnected'));
186
+ client.onData((data) => console.log('Data:', data));
187
+ client.onExit((code) => console.log('Exit:', code));
188
+ client.onError((err) => console.log('Error:', err));
189
+ client.onSpawned((info) => console.log('Spawned:', info));
190
+
191
+ // State getters
192
+ client.isConnected(); // boolean
193
+ client.hasActiveSession(); // boolean
194
+ client.getSessionId(); // string | null
195
+ client.getSessionInfo(); // SessionInfo | null
196
+ ```
197
+
198
+ ### UI Component
199
+
200
+ #### `<x-shell-terminal>`
201
+
202
+ ```html
203
+ <x-shell-terminal
204
+ url="ws://localhost:3000/terminal"
205
+ shell="/bin/bash"
206
+ cwd="/home/user"
207
+ theme="dark"
208
+ font-size="14"
209
+ font-family="Menlo, Monaco, monospace"
210
+ cols="80"
211
+ rows="24"
212
+ auto-connect
213
+ auto-spawn
214
+ no-header
215
+ ></x-shell-terminal>
216
+ ```
217
+
218
+ **Attributes:**
219
+
220
+ | Attribute | Type | Default | Description |
221
+ |-----------|------|---------|-------------|
222
+ | `url` | string | `''` | WebSocket URL |
223
+ | `shell` | string | `''` | Shell to use |
224
+ | `cwd` | string | `''` | Working directory |
225
+ | `theme` | `'dark'` \| `'light'` \| `'auto'` | `'dark'` | Color theme |
226
+ | `font-size` | number | `14` | Terminal font size |
227
+ | `font-family` | string | `'Menlo, Monaco, ...'` | Terminal font |
228
+ | `cols` | number | `80` | Initial columns |
229
+ | `rows` | number | `24` | Initial rows |
230
+ | `auto-connect` | boolean | `false` | Connect on mount |
231
+ | `auto-spawn` | boolean | `false` | Spawn on connect |
232
+ | `no-header` | boolean | `false` | Hide header bar |
233
+
234
+ **Methods:**
235
+
236
+ ```javascript
237
+ const terminal = document.querySelector('x-shell-terminal');
238
+
239
+ await terminal.connect(); // Connect to server
240
+ terminal.disconnect(); // Disconnect
241
+ await terminal.spawn(); // Spawn session
242
+ terminal.kill(); // Kill session
243
+ terminal.clear(); // Clear display
244
+ terminal.write('text'); // Write to display
245
+ terminal.writeln('line'); // Write line to display
246
+ terminal.focus(); // Focus terminal
247
+ ```
248
+
249
+ **Events:**
250
+
251
+ ```javascript
252
+ terminal.addEventListener('connect', () => {});
253
+ terminal.addEventListener('disconnect', () => {});
254
+ terminal.addEventListener('spawned', (e) => console.log(e.detail.session));
255
+ terminal.addEventListener('exit', (e) => console.log(e.detail.exitCode));
256
+ terminal.addEventListener('error', (e) => console.log(e.detail.error));
257
+ ```
258
+
259
+ ## Theming
260
+
261
+ The component uses CSS custom properties for theming:
262
+
263
+ ```css
264
+ x-shell-terminal {
265
+ --xs-bg: #1e1e1e;
266
+ --xs-bg-header: #2d2d2d;
267
+ --xs-text: #cccccc;
268
+ --xs-text-muted: #808080;
269
+ --xs-border: #3e3e3e;
270
+ --xs-terminal-bg: #1e1e1e;
271
+ --xs-terminal-fg: #cccccc;
272
+ --xs-terminal-cursor: #ffffff;
273
+ --xs-terminal-selection: #264f78;
274
+ --xs-btn-bg: #3c3c3c;
275
+ --xs-btn-text: #cccccc;
276
+ --xs-btn-hover: #4a4a4a;
277
+ --xs-status-connected: #22c55e;
278
+ --xs-status-disconnected: #ef4444;
279
+ }
280
+ ```
281
+
282
+ ## Security
283
+
284
+ **Always configure security for production:**
285
+
286
+ ```javascript
287
+ const server = new TerminalServer({
288
+ // Restrict allowed shells
289
+ allowedShells: ['/bin/bash'],
290
+
291
+ // Restrict working directories
292
+ allowedPaths: ['/home/app', '/var/www'],
293
+
294
+ // Limit sessions per client
295
+ maxSessionsPerClient: 2,
296
+
297
+ // Set idle timeout
298
+ idleTimeout: 10 * 60 * 1000, // 10 minutes
299
+ });
300
+ ```
301
+
302
+ ## License
303
+
304
+ MIT
@@ -0,0 +1,314 @@
1
+ // src/client/terminal-client.ts
2
+ var TerminalClient = class {
3
+ constructor(config) {
4
+ this.ws = null;
5
+ this.state = "disconnected";
6
+ this.sessionId = null;
7
+ this.sessionInfo = null;
8
+ this.reconnectAttempts = 0;
9
+ this.reconnectTimeout = null;
10
+ // Event handlers
11
+ this.connectHandlers = [];
12
+ this.disconnectHandlers = [];
13
+ this.dataHandlers = [];
14
+ this.exitHandlers = [];
15
+ this.errorHandlers = [];
16
+ this.spawnedHandlers = [];
17
+ // Promise resolvers for spawn
18
+ this.spawnResolve = null;
19
+ this.spawnReject = null;
20
+ this.config = {
21
+ url: config.url,
22
+ reconnect: config.reconnect ?? true,
23
+ maxReconnectAttempts: config.maxReconnectAttempts ?? 10,
24
+ reconnectDelay: config.reconnectDelay ?? 1e3
25
+ };
26
+ }
27
+ /**
28
+ * Connect to the terminal server
29
+ */
30
+ connect() {
31
+ return new Promise((resolve, reject) => {
32
+ if (this.state === "connected") {
33
+ resolve();
34
+ return;
35
+ }
36
+ this.state = "connecting";
37
+ try {
38
+ this.ws = new WebSocket(this.config.url);
39
+ } catch (error) {
40
+ this.state = "disconnected";
41
+ reject(error);
42
+ return;
43
+ }
44
+ this.ws.onopen = () => {
45
+ this.state = "connected";
46
+ this.reconnectAttempts = 0;
47
+ this.connectHandlers.forEach((handler) => handler());
48
+ resolve();
49
+ };
50
+ this.ws.onclose = () => {
51
+ const wasConnected = this.state === "connected";
52
+ this.state = "disconnected";
53
+ this.sessionId = null;
54
+ this.sessionInfo = null;
55
+ if (wasConnected) {
56
+ this.disconnectHandlers.forEach((handler) => handler());
57
+ }
58
+ if (this.config.reconnect && this.reconnectAttempts < this.config.maxReconnectAttempts) {
59
+ this.scheduleReconnect();
60
+ }
61
+ };
62
+ this.ws.onerror = (event) => {
63
+ const error = new Error("WebSocket error");
64
+ this.errorHandlers.forEach((handler) => handler(error));
65
+ if (this.state === "connecting") {
66
+ reject(error);
67
+ }
68
+ };
69
+ this.ws.onmessage = (event) => {
70
+ this.handleMessage(event.data);
71
+ };
72
+ });
73
+ }
74
+ /**
75
+ * Disconnect from the terminal server
76
+ */
77
+ disconnect() {
78
+ this.config.reconnect = false;
79
+ if (this.reconnectTimeout) {
80
+ clearTimeout(this.reconnectTimeout);
81
+ this.reconnectTimeout = null;
82
+ }
83
+ if (this.ws) {
84
+ this.ws.close();
85
+ this.ws = null;
86
+ }
87
+ this.state = "disconnected";
88
+ this.sessionId = null;
89
+ this.sessionInfo = null;
90
+ }
91
+ /**
92
+ * Schedule a reconnection attempt
93
+ */
94
+ scheduleReconnect() {
95
+ if (this.reconnectTimeout)
96
+ return;
97
+ const delay = this.config.reconnectDelay * Math.pow(2, this.reconnectAttempts);
98
+ const maxDelay = 3e4;
99
+ this.reconnectTimeout = setTimeout(() => {
100
+ this.reconnectTimeout = null;
101
+ this.reconnectAttempts++;
102
+ this.connect().catch(() => {
103
+ });
104
+ }, Math.min(delay, maxDelay));
105
+ }
106
+ /**
107
+ * Handle incoming message
108
+ */
109
+ handleMessage(data) {
110
+ let message;
111
+ try {
112
+ message = JSON.parse(data);
113
+ } catch {
114
+ console.error("[x-shell] Invalid message:", data);
115
+ return;
116
+ }
117
+ switch (message.type) {
118
+ case "spawned":
119
+ this.sessionId = message.sessionId;
120
+ this.sessionInfo = {
121
+ sessionId: message.sessionId,
122
+ shell: message.shell,
123
+ cwd: message.cwd,
124
+ cols: message.cols,
125
+ rows: message.rows,
126
+ createdAt: /* @__PURE__ */ new Date()
127
+ };
128
+ this.spawnedHandlers.forEach((handler) => handler(this.sessionInfo));
129
+ if (this.spawnResolve) {
130
+ this.spawnResolve(this.sessionInfo);
131
+ this.spawnResolve = null;
132
+ this.spawnReject = null;
133
+ }
134
+ break;
135
+ case "data":
136
+ this.dataHandlers.forEach((handler) => handler(message.data));
137
+ break;
138
+ case "exit":
139
+ const exitCode = message.exitCode;
140
+ this.exitHandlers.forEach((handler) => handler(exitCode));
141
+ this.sessionId = null;
142
+ this.sessionInfo = null;
143
+ break;
144
+ case "error":
145
+ const error = new Error(message.error);
146
+ this.errorHandlers.forEach((handler) => handler(error));
147
+ if (this.spawnReject) {
148
+ this.spawnReject(error);
149
+ this.spawnResolve = null;
150
+ this.spawnReject = null;
151
+ }
152
+ break;
153
+ }
154
+ }
155
+ /**
156
+ * Spawn a terminal session
157
+ */
158
+ spawn(options = {}) {
159
+ return new Promise((resolve, reject) => {
160
+ if (this.state !== "connected" || !this.ws) {
161
+ reject(new Error("Not connected to server"));
162
+ return;
163
+ }
164
+ if (this.sessionId) {
165
+ reject(new Error("Session already spawned. Call kill() first."));
166
+ return;
167
+ }
168
+ this.spawnResolve = resolve;
169
+ this.spawnReject = reject;
170
+ this.ws.send(
171
+ JSON.stringify({
172
+ type: "spawn",
173
+ options
174
+ })
175
+ );
176
+ });
177
+ }
178
+ /**
179
+ * Write data to the terminal
180
+ */
181
+ write(data) {
182
+ if (!this.ws || this.state !== "connected") {
183
+ console.error("[x-shell] Cannot write: not connected");
184
+ return;
185
+ }
186
+ if (!this.sessionId) {
187
+ console.error("[x-shell] Cannot write: no active session");
188
+ return;
189
+ }
190
+ this.ws.send(
191
+ JSON.stringify({
192
+ type: "data",
193
+ sessionId: this.sessionId,
194
+ data
195
+ })
196
+ );
197
+ }
198
+ /**
199
+ * Resize the terminal
200
+ */
201
+ resize(cols, rows) {
202
+ if (!this.ws || this.state !== "connected") {
203
+ console.error("[x-shell] Cannot resize: not connected");
204
+ return;
205
+ }
206
+ if (!this.sessionId) {
207
+ console.error("[x-shell] Cannot resize: no active session");
208
+ return;
209
+ }
210
+ this.ws.send(
211
+ JSON.stringify({
212
+ type: "resize",
213
+ sessionId: this.sessionId,
214
+ cols,
215
+ rows
216
+ })
217
+ );
218
+ }
219
+ /**
220
+ * Kill the terminal session
221
+ */
222
+ kill() {
223
+ if (!this.ws || this.state !== "connected") {
224
+ return;
225
+ }
226
+ if (!this.sessionId) {
227
+ return;
228
+ }
229
+ this.ws.send(
230
+ JSON.stringify({
231
+ type: "close",
232
+ sessionId: this.sessionId
233
+ })
234
+ );
235
+ this.sessionId = null;
236
+ this.sessionInfo = null;
237
+ }
238
+ // ==========================================
239
+ // Event handlers
240
+ // ==========================================
241
+ /**
242
+ * Called when connected to server
243
+ */
244
+ onConnect(handler) {
245
+ this.connectHandlers.push(handler);
246
+ }
247
+ /**
248
+ * Called when disconnected from server
249
+ */
250
+ onDisconnect(handler) {
251
+ this.disconnectHandlers.push(handler);
252
+ }
253
+ /**
254
+ * Called when data is received from the terminal
255
+ */
256
+ onData(handler) {
257
+ this.dataHandlers.push(handler);
258
+ }
259
+ /**
260
+ * Called when the terminal session exits
261
+ */
262
+ onExit(handler) {
263
+ this.exitHandlers.push(handler);
264
+ }
265
+ /**
266
+ * Called when an error occurs
267
+ */
268
+ onError(handler) {
269
+ this.errorHandlers.push(handler);
270
+ }
271
+ /**
272
+ * Called when a session is spawned
273
+ */
274
+ onSpawned(handler) {
275
+ this.spawnedHandlers.push(handler);
276
+ }
277
+ // ==========================================
278
+ // Getters
279
+ // ==========================================
280
+ /**
281
+ * Get current connection state
282
+ */
283
+ getState() {
284
+ return this.state;
285
+ }
286
+ /**
287
+ * Check if connected
288
+ */
289
+ isConnected() {
290
+ return this.state === "connected";
291
+ }
292
+ /**
293
+ * Get current session ID
294
+ */
295
+ getSessionId() {
296
+ return this.sessionId;
297
+ }
298
+ /**
299
+ * Get current session info
300
+ */
301
+ getSessionInfo() {
302
+ return this.sessionInfo;
303
+ }
304
+ /**
305
+ * Check if a session is active
306
+ */
307
+ hasActiveSession() {
308
+ return this.sessionId !== null;
309
+ }
310
+ };
311
+ export {
312
+ TerminalClient
313
+ };
314
+ //# sourceMappingURL=browser-bundle.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../src/client/terminal-client.ts"],
4
+ "sourcesContent": ["/**\r\n * Terminal client for connecting to x-shell server\r\n *\r\n * Example usage:\r\n * ```typescript\r\n * import { TerminalClient } from 'x-shell.js/client';\r\n *\r\n * const client = new TerminalClient({ url: 'ws://localhost:3000/terminal' });\r\n * await client.connect();\r\n *\r\n * client.onData((data) => console.log(data));\r\n * client.onExit((code) => console.log('Exited with code:', code));\r\n *\r\n * await client.spawn({ shell: '/bin/bash', cwd: '/home/user' });\r\n * client.write('ls -la\\n');\r\n * client.resize(120, 40);\r\n * client.kill();\r\n * ```\r\n */\r\n\r\nimport type {\r\n ClientConfig,\r\n TerminalOptions,\r\n TerminalMessage,\r\n SessionInfo,\r\n} from '../shared/types.js';\r\n\r\n/**\r\n * Connection state\r\n */\r\nexport type ConnectionState = 'disconnected' | 'connecting' | 'connected';\r\n\r\n/**\r\n * Terminal client class\r\n */\r\nexport class TerminalClient {\r\n private config: Required<ClientConfig>;\r\n private ws: WebSocket | null = null;\r\n private state: ConnectionState = 'disconnected';\r\n private sessionId: string | null = null;\r\n private sessionInfo: SessionInfo | null = null;\r\n private reconnectAttempts = 0;\r\n private reconnectTimeout: ReturnType<typeof setTimeout> | null = null;\r\n\r\n // Event handlers\r\n private connectHandlers: (() => void)[] = [];\r\n private disconnectHandlers: (() => void)[] = [];\r\n private dataHandlers: ((data: string) => void)[] = [];\r\n private exitHandlers: ((code: number) => void)[] = [];\r\n private errorHandlers: ((error: Error) => void)[] = [];\r\n private spawnedHandlers: ((info: SessionInfo) => void)[] = [];\r\n\r\n // Promise resolvers for spawn\r\n private spawnResolve: ((info: SessionInfo) => void) | null = null;\r\n private spawnReject: ((error: Error) => void) | null = null;\r\n\r\n constructor(config: ClientConfig) {\r\n this.config = {\r\n url: config.url,\r\n reconnect: config.reconnect ?? true,\r\n maxReconnectAttempts: config.maxReconnectAttempts ?? 10,\r\n reconnectDelay: config.reconnectDelay ?? 1000,\r\n };\r\n }\r\n\r\n /**\r\n * Connect to the terminal server\r\n */\r\n connect(): Promise<void> {\r\n return new Promise((resolve, reject) => {\r\n if (this.state === 'connected') {\r\n resolve();\r\n return;\r\n }\r\n\r\n this.state = 'connecting';\r\n\r\n try {\r\n this.ws = new WebSocket(this.config.url);\r\n } catch (error) {\r\n this.state = 'disconnected';\r\n reject(error);\r\n return;\r\n }\r\n\r\n this.ws.onopen = () => {\r\n this.state = 'connected';\r\n this.reconnectAttempts = 0;\r\n this.connectHandlers.forEach((handler) => handler());\r\n resolve();\r\n };\r\n\r\n this.ws.onclose = () => {\r\n const wasConnected = this.state === 'connected';\r\n this.state = 'disconnected';\r\n this.sessionId = null;\r\n this.sessionInfo = null;\r\n\r\n if (wasConnected) {\r\n this.disconnectHandlers.forEach((handler) => handler());\r\n }\r\n\r\n // Attempt reconnection\r\n if (this.config.reconnect && this.reconnectAttempts < this.config.maxReconnectAttempts) {\r\n this.scheduleReconnect();\r\n }\r\n };\r\n\r\n this.ws.onerror = (event) => {\r\n const error = new Error('WebSocket error');\r\n this.errorHandlers.forEach((handler) => handler(error));\r\n\r\n if (this.state === 'connecting') {\r\n reject(error);\r\n }\r\n };\r\n\r\n this.ws.onmessage = (event) => {\r\n this.handleMessage(event.data);\r\n };\r\n });\r\n }\r\n\r\n /**\r\n * Disconnect from the terminal server\r\n */\r\n disconnect(): void {\r\n this.config.reconnect = false; // Prevent auto-reconnect\r\n\r\n if (this.reconnectTimeout) {\r\n clearTimeout(this.reconnectTimeout);\r\n this.reconnectTimeout = null;\r\n }\r\n\r\n if (this.ws) {\r\n this.ws.close();\r\n this.ws = null;\r\n }\r\n\r\n this.state = 'disconnected';\r\n this.sessionId = null;\r\n this.sessionInfo = null;\r\n }\r\n\r\n /**\r\n * Schedule a reconnection attempt\r\n */\r\n private scheduleReconnect(): void {\r\n if (this.reconnectTimeout) return;\r\n\r\n const delay = this.config.reconnectDelay * Math.pow(2, this.reconnectAttempts);\r\n const maxDelay = 30000; // 30 seconds max\r\n\r\n this.reconnectTimeout = setTimeout(() => {\r\n this.reconnectTimeout = null;\r\n this.reconnectAttempts++;\r\n this.connect().catch(() => {\r\n // Error handled by onclose\r\n });\r\n }, Math.min(delay, maxDelay));\r\n }\r\n\r\n /**\r\n * Handle incoming message\r\n */\r\n private handleMessage(data: string): void {\r\n let message: TerminalMessage;\r\n\r\n try {\r\n message = JSON.parse(data);\r\n } catch {\r\n console.error('[x-shell] Invalid message:', data);\r\n return;\r\n }\r\n\r\n switch (message.type) {\r\n case 'spawned':\r\n this.sessionId = message.sessionId;\r\n this.sessionInfo = {\r\n sessionId: message.sessionId,\r\n shell: message.shell,\r\n cwd: message.cwd,\r\n cols: message.cols,\r\n rows: message.rows,\r\n createdAt: new Date(),\r\n };\r\n this.spawnedHandlers.forEach((handler) => handler(this.sessionInfo!));\r\n if (this.spawnResolve) {\r\n this.spawnResolve(this.sessionInfo);\r\n this.spawnResolve = null;\r\n this.spawnReject = null;\r\n }\r\n break;\r\n\r\n case 'data':\r\n this.dataHandlers.forEach((handler) => handler(message.data));\r\n break;\r\n\r\n case 'exit':\r\n const exitCode = message.exitCode;\r\n this.exitHandlers.forEach((handler) => handler(exitCode));\r\n this.sessionId = null;\r\n this.sessionInfo = null;\r\n break;\r\n\r\n case 'error':\r\n const error = new Error(message.error);\r\n this.errorHandlers.forEach((handler) => handler(error));\r\n if (this.spawnReject) {\r\n this.spawnReject(error);\r\n this.spawnResolve = null;\r\n this.spawnReject = null;\r\n }\r\n break;\r\n }\r\n }\r\n\r\n /**\r\n * Spawn a terminal session\r\n */\r\n spawn(options: TerminalOptions = {}): Promise<SessionInfo> {\r\n return new Promise((resolve, reject) => {\r\n if (this.state !== 'connected' || !this.ws) {\r\n reject(new Error('Not connected to server'));\r\n return;\r\n }\r\n\r\n if (this.sessionId) {\r\n reject(new Error('Session already spawned. Call kill() first.'));\r\n return;\r\n }\r\n\r\n this.spawnResolve = resolve;\r\n this.spawnReject = reject;\r\n\r\n this.ws.send(\r\n JSON.stringify({\r\n type: 'spawn',\r\n options,\r\n })\r\n );\r\n });\r\n }\r\n\r\n /**\r\n * Write data to the terminal\r\n */\r\n write(data: string): void {\r\n if (!this.ws || this.state !== 'connected') {\r\n console.error('[x-shell] Cannot write: not connected');\r\n return;\r\n }\r\n\r\n if (!this.sessionId) {\r\n console.error('[x-shell] Cannot write: no active session');\r\n return;\r\n }\r\n\r\n this.ws.send(\r\n JSON.stringify({\r\n type: 'data',\r\n sessionId: this.sessionId,\r\n data,\r\n })\r\n );\r\n }\r\n\r\n /**\r\n * Resize the terminal\r\n */\r\n resize(cols: number, rows: number): void {\r\n if (!this.ws || this.state !== 'connected') {\r\n console.error('[x-shell] Cannot resize: not connected');\r\n return;\r\n }\r\n\r\n if (!this.sessionId) {\r\n console.error('[x-shell] Cannot resize: no active session');\r\n return;\r\n }\r\n\r\n this.ws.send(\r\n JSON.stringify({\r\n type: 'resize',\r\n sessionId: this.sessionId,\r\n cols,\r\n rows,\r\n })\r\n );\r\n }\r\n\r\n /**\r\n * Kill the terminal session\r\n */\r\n kill(): void {\r\n if (!this.ws || this.state !== 'connected') {\r\n return;\r\n }\r\n\r\n if (!this.sessionId) {\r\n return;\r\n }\r\n\r\n this.ws.send(\r\n JSON.stringify({\r\n type: 'close',\r\n sessionId: this.sessionId,\r\n })\r\n );\r\n\r\n this.sessionId = null;\r\n this.sessionInfo = null;\r\n }\r\n\r\n // ==========================================\r\n // Event handlers\r\n // ==========================================\r\n\r\n /**\r\n * Called when connected to server\r\n */\r\n onConnect(handler: () => void): void {\r\n this.connectHandlers.push(handler);\r\n }\r\n\r\n /**\r\n * Called when disconnected from server\r\n */\r\n onDisconnect(handler: () => void): void {\r\n this.disconnectHandlers.push(handler);\r\n }\r\n\r\n /**\r\n * Called when data is received from the terminal\r\n */\r\n onData(handler: (data: string) => void): void {\r\n this.dataHandlers.push(handler);\r\n }\r\n\r\n /**\r\n * Called when the terminal session exits\r\n */\r\n onExit(handler: (code: number) => void): void {\r\n this.exitHandlers.push(handler);\r\n }\r\n\r\n /**\r\n * Called when an error occurs\r\n */\r\n onError(handler: (error: Error) => void): void {\r\n this.errorHandlers.push(handler);\r\n }\r\n\r\n /**\r\n * Called when a session is spawned\r\n */\r\n onSpawned(handler: (info: SessionInfo) => void): void {\r\n this.spawnedHandlers.push(handler);\r\n }\r\n\r\n // ==========================================\r\n // Getters\r\n // ==========================================\r\n\r\n /**\r\n * Get current connection state\r\n */\r\n getState(): ConnectionState {\r\n return this.state;\r\n }\r\n\r\n /**\r\n * Check if connected\r\n */\r\n isConnected(): boolean {\r\n return this.state === 'connected';\r\n }\r\n\r\n /**\r\n * Get current session ID\r\n */\r\n getSessionId(): string | null {\r\n return this.sessionId;\r\n }\r\n\r\n /**\r\n * Get current session info\r\n */\r\n getSessionInfo(): SessionInfo | null {\r\n return this.sessionInfo;\r\n }\r\n\r\n /**\r\n * Check if a session is active\r\n */\r\n hasActiveSession(): boolean {\r\n return this.sessionId !== null;\r\n }\r\n}\r\n"],
5
+ "mappings": ";AAmCO,IAAM,iBAAN,MAAqB;AAAA,EAqB1B,YAAY,QAAsB;AAnBlC,SAAQ,KAAuB;AAC/B,SAAQ,QAAyB;AACjC,SAAQ,YAA2B;AACnC,SAAQ,cAAkC;AAC1C,SAAQ,oBAAoB;AAC5B,SAAQ,mBAAyD;AAGjE;AAAA,SAAQ,kBAAkC,CAAC;AAC3C,SAAQ,qBAAqC,CAAC;AAC9C,SAAQ,eAA2C,CAAC;AACpD,SAAQ,eAA2C,CAAC;AACpD,SAAQ,gBAA4C,CAAC;AACrD,SAAQ,kBAAmD,CAAC;AAG5D;AAAA,SAAQ,eAAqD;AAC7D,SAAQ,cAA+C;AAGrD,SAAK,SAAS;AAAA,MACZ,KAAK,OAAO;AAAA,MACZ,WAAW,OAAO,aAAa;AAAA,MAC/B,sBAAsB,OAAO,wBAAwB;AAAA,MACrD,gBAAgB,OAAO,kBAAkB;AAAA,IAC3C;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,UAAyB;AACvB,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,KAAK,UAAU,aAAa;AAC9B,gBAAQ;AACR;AAAA,MACF;AAEA,WAAK,QAAQ;AAEb,UAAI;AACF,aAAK,KAAK,IAAI,UAAU,KAAK,OAAO,GAAG;AAAA,MACzC,SAAS,OAAO;AACd,aAAK,QAAQ;AACb,eAAO,KAAK;AACZ;AAAA,MACF;AAEA,WAAK,GAAG,SAAS,MAAM;AACrB,aAAK,QAAQ;AACb,aAAK,oBAAoB;AACzB,aAAK,gBAAgB,QAAQ,CAAC,YAAY,QAAQ,CAAC;AACnD,gBAAQ;AAAA,MACV;AAEA,WAAK,GAAG,UAAU,MAAM;AACtB,cAAM,eAAe,KAAK,UAAU;AACpC,aAAK,QAAQ;AACb,aAAK,YAAY;AACjB,aAAK,cAAc;AAEnB,YAAI,cAAc;AAChB,eAAK,mBAAmB,QAAQ,CAAC,YAAY,QAAQ,CAAC;AAAA,QACxD;AAGA,YAAI,KAAK,OAAO,aAAa,KAAK,oBAAoB,KAAK,OAAO,sBAAsB;AACtF,eAAK,kBAAkB;AAAA,QACzB;AAAA,MACF;AAEA,WAAK,GAAG,UAAU,CAAC,UAAU;AAC3B,cAAM,QAAQ,IAAI,MAAM,iBAAiB;AACzC,aAAK,cAAc,QAAQ,CAAC,YAAY,QAAQ,KAAK,CAAC;AAEtD,YAAI,KAAK,UAAU,cAAc;AAC/B,iBAAO,KAAK;AAAA,QACd;AAAA,MACF;AAEA,WAAK,GAAG,YAAY,CAAC,UAAU;AAC7B,aAAK,cAAc,MAAM,IAAI;AAAA,MAC/B;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,aAAmB;AACjB,SAAK,OAAO,YAAY;AAExB,QAAI,KAAK,kBAAkB;AACzB,mBAAa,KAAK,gBAAgB;AAClC,WAAK,mBAAmB;AAAA,IAC1B;AAEA,QAAI,KAAK,IAAI;AACX,WAAK,GAAG,MAAM;AACd,WAAK,KAAK;AAAA,IACZ;AAEA,SAAK,QAAQ;AACb,SAAK,YAAY;AACjB,SAAK,cAAc;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA,EAKQ,oBAA0B;AAChC,QAAI,KAAK;AAAkB;AAE3B,UAAM,QAAQ,KAAK,OAAO,iBAAiB,KAAK,IAAI,GAAG,KAAK,iBAAiB;AAC7E,UAAM,WAAW;AAEjB,SAAK,mBAAmB,WAAW,MAAM;AACvC,WAAK,mBAAmB;AACxB,WAAK;AACL,WAAK,QAAQ,EAAE,MAAM,MAAM;AAAA,MAE3B,CAAC;AAAA,IACH,GAAG,KAAK,IAAI,OAAO,QAAQ,CAAC;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA,EAKQ,cAAc,MAAoB;AACxC,QAAI;AAEJ,QAAI;AACF,gBAAU,KAAK,MAAM,IAAI;AAAA,IAC3B,QAAQ;AACN,cAAQ,MAAM,8BAA8B,IAAI;AAChD;AAAA,IACF;AAEA,YAAQ,QAAQ,MAAM;AAAA,MACpB,KAAK;AACH,aAAK,YAAY,QAAQ;AACzB,aAAK,cAAc;AAAA,UACjB,WAAW,QAAQ;AAAA,UACnB,OAAO,QAAQ;AAAA,UACf,KAAK,QAAQ;AAAA,UACb,MAAM,QAAQ;AAAA,UACd,MAAM,QAAQ;AAAA,UACd,WAAW,oBAAI,KAAK;AAAA,QACtB;AACA,aAAK,gBAAgB,QAAQ,CAAC,YAAY,QAAQ,KAAK,WAAY,CAAC;AACpE,YAAI,KAAK,cAAc;AACrB,eAAK,aAAa,KAAK,WAAW;AAClC,eAAK,eAAe;AACpB,eAAK,cAAc;AAAA,QACrB;AACA;AAAA,MAEF,KAAK;AACH,aAAK,aAAa,QAAQ,CAAC,YAAY,QAAQ,QAAQ,IAAI,CAAC;AAC5D;AAAA,MAEF,KAAK;AACH,cAAM,WAAW,QAAQ;AACzB,aAAK,aAAa,QAAQ,CAAC,YAAY,QAAQ,QAAQ,CAAC;AACxD,aAAK,YAAY;AACjB,aAAK,cAAc;AACnB;AAAA,MAEF,KAAK;AACH,cAAM,QAAQ,IAAI,MAAM,QAAQ,KAAK;AACrC,aAAK,cAAc,QAAQ,CAAC,YAAY,QAAQ,KAAK,CAAC;AACtD,YAAI,KAAK,aAAa;AACpB,eAAK,YAAY,KAAK;AACtB,eAAK,eAAe;AACpB,eAAK,cAAc;AAAA,QACrB;AACA;AAAA,IACJ;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,UAA2B,CAAC,GAAyB;AACzD,WAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAI,KAAK,UAAU,eAAe,CAAC,KAAK,IAAI;AAC1C,eAAO,IAAI,MAAM,yBAAyB,CAAC;AAC3C;AAAA,MACF;AAEA,UAAI,KAAK,WAAW;AAClB,eAAO,IAAI,MAAM,6CAA6C,CAAC;AAC/D;AAAA,MACF;AAEA,WAAK,eAAe;AACpB,WAAK,cAAc;AAEnB,WAAK,GAAG;AAAA,QACN,KAAK,UAAU;AAAA,UACb,MAAM;AAAA,UACN;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,MAAoB;AACxB,QAAI,CAAC,KAAK,MAAM,KAAK,UAAU,aAAa;AAC1C,cAAQ,MAAM,uCAAuC;AACrD;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,WAAW;AACnB,cAAQ,MAAM,2CAA2C;AACzD;AAAA,IACF;AAEA,SAAK,GAAG;AAAA,MACN,KAAK,UAAU;AAAA,QACb,MAAM;AAAA,QACN,WAAW,KAAK;AAAA,QAChB;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,MAAc,MAAoB;AACvC,QAAI,CAAC,KAAK,MAAM,KAAK,UAAU,aAAa;AAC1C,cAAQ,MAAM,wCAAwC;AACtD;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,WAAW;AACnB,cAAQ,MAAM,4CAA4C;AAC1D;AAAA,IACF;AAEA,SAAK,GAAG;AAAA,MACN,KAAK,UAAU;AAAA,QACb,MAAM;AAAA,QACN,WAAW,KAAK;AAAA,QAChB;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKA,OAAa;AACX,QAAI,CAAC,KAAK,MAAM,KAAK,UAAU,aAAa;AAC1C;AAAA,IACF;AAEA,QAAI,CAAC,KAAK,WAAW;AACnB;AAAA,IACF;AAEA,SAAK,GAAG;AAAA,MACN,KAAK,UAAU;AAAA,QACb,MAAM;AAAA,QACN,WAAW,KAAK;AAAA,MAClB,CAAC;AAAA,IACH;AAEA,SAAK,YAAY;AACjB,SAAK,cAAc;AAAA,EACrB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,UAAU,SAA2B;AACnC,SAAK,gBAAgB,KAAK,OAAO;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,SAA2B;AACtC,SAAK,mBAAmB,KAAK,OAAO;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,SAAuC;AAC5C,SAAK,aAAa,KAAK,OAAO;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,SAAuC;AAC5C,SAAK,aAAa,KAAK,OAAO;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ,SAAuC;AAC7C,SAAK,cAAc,KAAK,OAAO;AAAA,EACjC;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU,SAA4C;AACpD,SAAK,gBAAgB,KAAK,OAAO;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,WAA4B;AAC1B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,cAAuB;AACrB,WAAO,KAAK,UAAU;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAKA,eAA8B;AAC5B,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,iBAAqC;AACnC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA,EAKA,mBAA4B;AAC1B,WAAO,KAAK,cAAc;AAAA,EAC5B;AACF;",
6
+ "names": []
7
+ }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * x-shell.js client exports
3
+ */
4
+ export { TerminalClient } from './terminal-client.js';
5
+ export type { ConnectionState } from './terminal-client.js';
6
+ export type { ClientConfig, TerminalOptions, SessionInfo, } from '../shared/types.js';
7
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,YAAY,EACV,YAAY,EACZ,eAAe,EACf,WAAW,GACZ,MAAM,oBAAoB,CAAC"}
@@ -0,0 +1,5 @@
1
+ /**
2
+ * x-shell.js client exports
3
+ */
4
+ export { TerminalClient } from './terminal-client.js';
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC"}