@difizen/libro-terminal 0.1.0 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@difizen/libro-terminal",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "",
   "keywords": [
     "libro"
@@ -31,14 +31,19 @@
     "src"
   ],
   "dependencies": {
-    "@difizen/libro-core": "^0.1.0",
-    "@difizen/libro-common": "^0.1.0",
-    "@difizen/libro-kernel": "^0.1.0",
+    "@difizen/libro-core": "^0.1.2",
+    "@difizen/libro-common": "^0.1.2",
+    "@difizen/libro-kernel": "^0.1.2",
     "@difizen/mana-app": "latest",
     "@ant-design/icons": "^5.1.0",
-    "xterm": "^4.16.0",
-    "xterm-addon-fit": "^0.5.0",
-    "xterm-addon-search": "^0.8.2"
+    "xterm-addon-search": "^0.13.0",
+    "xterm": "~5.1.0",
+    "xterm-addon-canvas": "~0.3.0",
+    "xterm-addon-fit": "~0.7.0",
+    "xterm-addon-web-links": "~0.8.0",
+    "xterm-addon-webgl": "~0.14.0",
+    "@types/lodash.throttle": "^4.1.1",
+    "lodash.throttle": "^4.1.1"
   },
   "peerDependencies": {
     "antd": "^5.8.6",

package/src/connection.ts

@@ -1,6 +1,7 @@
 import type { JSONPrimitive } from '@difizen/libro-common';
 import { URL } from '@difizen/libro-common';
 import type { ISettings } from '@difizen/libro-kernel';
+import { ServerConnection } from '@difizen/libro-kernel';
 import type { Disposable, Disposed, Event } from '@difizen/mana-app';
 import { transient } from '@difizen/mana-app';
 import { Deferred } from '@difizen/mana-app';
@@ -38,7 +39,11 @@ export class TerminalConnection implements Disposable, Disposed {
   /**
    * Construct a new terminal session.
    */
-  constructor(@inject(TerminalOption) options: TerminalOption & { name: string }) {
+  constructor(
+    @inject(TerminalOption) options: TerminalOption & { name: string },
+    @inject(ServerConnection) serverConnection: ServerConnection,
+  ) {
+    this.serverSettings = serverConnection.settings;
     this._name = options.name;
     this._createSocket();
   }
@@ -81,6 +86,7 @@ export class TerminalConnection implements Disposable, Disposed {
       return;
     }
     this.disposed = true;
+    this.shutdown().catch(console.error);
     this._updateConnectionStatus('disconnected');
     this._clearSocket();
   }
@@ -135,7 +141,7 @@ export class TerminalConnection implements Disposable, Disposed {
   /**
    * Reconnect to a terminal.
    */
-  reconnect(): Promise<void> {
+  reconnect = (): Promise<void> => {
     this._errorIfDisposed();
     const result = new Deferred<void>();
 
@@ -162,7 +168,7 @@ export class TerminalConnection implements Disposable, Disposed {
     // Return the promise that should resolve on connection or reject if the
     // retries don't work.
     return result.promise;
-  }
+  };
 
   /**
    * Attempt a connection if we have not exhausted connection attempts.

package/src/index.less

@@ -0,0 +1,9 @@
+.libro-terminal {
+  width: 100%;
+  height: 100%;
+
+  .xterm {
+    width: 100%;
+    height: 100%;
+  }
+}

package/src/index.spec.ts

@@ -1,8 +1,8 @@
-import {} from './index.js';
+import assert from 'assert';
 import 'reflect-metadata';
 
 describe('libro-widget', () => {
   it('#import', () => {
-    //
+    assert(true);
   });
 });

package/src/index.ts

@@ -1 +1,11 @@
+export * from './manager.js';
+export * from './view.js';
+export * from './theme-service.js';
+export * from './restapi.js';
+export * from './configuration.js';
+
 export * from './module.js';
+export * from './view.js';
+export * from './manager.js';
+export * from './protocol.js';
+export * from './configuration.js';

package/src/manager.ts

@@ -3,7 +3,7 @@
 
 import { Poll } from '@difizen/libro-common';
 import type { ISettings } from '@difizen/libro-kernel';
-import { NetworkError } from '@difizen/libro-kernel';
+import { NetworkError, ServerConnection } from '@difizen/libro-kernel';
 import type { Disposable, Disposed, Event } from '@difizen/mana-app';
 import { singleton } from '@difizen/mana-app';
 import { Emitter, inject } from '@difizen/mana-app';
@@ -31,12 +31,16 @@ export class TerminalManager implements Disposable, Disposed {
   }
 
   @inject(TerminalRestAPI) terminalRestAPI: TerminalRestAPI;
+  // @inject(ServerConnection) serverConnection: ServerConnection;
   @inject(TerminalConnectionFactory)
   terminalConnectionFactory: TerminalConnectionFactory;
   /**
    * Construct a new terminal manager.
    */
-  constructor() {
+  constructor(@inject(ServerConnection) serverConnection: ServerConnection) {
+    this.serverSettings = serverConnection.settings;
+
+    //
     // Start polling with exponential backoff.
     this._pollModels = new Poll({
       auto: false,
@@ -198,7 +202,7 @@ export class TerminalManager implements Disposable, Disposed {
   /**
    * Execute a request to the server to poll running terminals and update state.
    */
-  protected async requestRunning(): Promise<void> {
+  async requestRunning(): Promise<void> {
     let models: TerminalModel[];
     try {
       models = await this.terminalRestAPI.listRunning(this.serverSettings);

package/src/module.ts

@@ -1,18 +1,32 @@
+import {
+  KernelSpecRestAPI,
+  ServerConnection,
+  ServerManager,
+} from '@difizen/libro-kernel';
 import { ManaModule } from '@difizen/mana-app';
 
 import { TerminalConfiguration } from './configuration.js';
 import { TerminalConnection } from './connection.js';
+import './index.less';
 import { TerminalManager } from './manager.js';
-import { TerminalOption } from './protocol.js';
-import { TerminalConnectionFactory } from './protocol.js';
+import {
+  TerminalConnectionFactory,
+  TerminalOption,
+  TerminalViewOption,
+} from './protocol.js';
 import { TerminalRestAPI } from './restapi.js';
 import { TerminalThemeService } from './theme-service.js';
 import { LibroTerminalView } from './view.js';
 
 export const TerminalModule = ManaModule.create().register(
+  TerminalConfiguration,
   TerminalConnection,
   TerminalManager,
   TerminalRestAPI,
+  LibroTerminalView,
+  ServerConnection,
+  ServerManager,
+  KernelSpecRestAPI,
   {
     token: TerminalConnectionFactory,
     useFactory: (ctx) => {
@@ -23,7 +37,11 @@ export const TerminalModule = ManaModule.create().register(
       };
     },
   },
-  TerminalConfiguration,
+  {
+    token: TerminalViewOption,
+    useValue: {
+      // initialCommand: '',
+    },
+  },
   TerminalThemeService,
-  LibroTerminalView,
 );

package/src/protocol.ts

@@ -85,8 +85,9 @@ export interface TerminalViewOption extends TerminalOption {
 
   /**
    * Whether it is a pseudo terminal where an extension controls its input and output.
+   * 在jupyter中默认用的pseudo terminal
    */
-  readonly isPseudoTerminal?: boolean;
+  // readonly isPseudoTerminal?: boolean;
 
   /**
    * Terminal attributes. Can be useful to apply some implementation specific information.

package/src/restapi.ts

@@ -24,7 +24,8 @@ export class TerminalRestAPI {
     };
     const response = await this.serverConnection.makeRequest(url, init, settings);
 
-    if (response.status !== 201) {
+    // 后端返回200
+    if (response.status !== 200) {
       const err = await createResponseError(response);
       throw err;
     }

package/src/stateful-view.ts

@@ -0,0 +1,20 @@
+import type { StatefulView } from '@difizen/mana-app';
+import { BaseView } from '@difizen/mana-app';
+
+export abstract class BaseStatefulView extends BaseView implements StatefulView {
+  constructor() {
+    super();
+    // setImmediate(() => {});
+    Promise.resolve()
+      .then(() => {
+        return this.afterRestore();
+      })
+      .catch(console.error);
+  }
+  abstract storeState(): Record<string, any>;
+  abstract restoreState(oldState: Record<string, any>): void;
+
+  afterRestore() {
+    // do nothing
+  }
+}

package/src/theme-service.ts

@@ -157,7 +157,7 @@ export class TerminalThemeService {
     const cursorAccentColor =
       this.colorRegistry.getCurrentColor('terminalCursor.background') ||
       backgroundColor;
-    const selectionColor = this.colorRegistry.getCurrentColor(
+    const selectionBackground = this.colorRegistry.getCurrentColor(
       'terminal.selectionBackground',
     );
 
@@ -166,7 +166,8 @@ export class TerminalThemeService {
       foreground: foregroundColor,
       cursor: cursorColor,
       cursorAccent: cursorAccentColor,
-      selection: selectionColor,
+      selectionBackground: selectionBackground,
+      // selection: selectionColor,
     };
     // eslint-disable-next-line guard-for-in
     for (const id in terminalAnsiColorMap) {
@@ -177,4 +178,35 @@ export class TerminalThemeService {
     }
     return theme;
   }
+
+  getTheme(type: 'light' | 'dark' | 'default' = 'light'): ITheme {
+    switch (type) {
+      case 'light':
+        return this.lightTheme;
+      case 'dark':
+        return this.darkTheme;
+      case 'default':
+      default:
+        return this.theme;
+    }
+  }
+
+  // jupyter terminal theme
+  lightTheme: ITheme = {
+    foreground: '#000',
+    background: '#fff',
+    cursor: '#616161', // md-grey-700
+    cursorAccent: '#F5F5F5', // md-grey-100
+    selectionBackground: 'rgba(97, 97, 97, 0.3)', // md-grey-700
+    selectionInactiveBackground: 'rgba(189, 189, 189, 0.3)', // md-grey-400
+  };
+
+  darkTheme: ITheme = {
+    foreground: '#fff',
+    background: '#000',
+    cursor: '#fff',
+    cursorAccent: '#000',
+    selectionBackground: 'rgba(255, 255, 255, 0.3)',
+    selectionInactiveBackground: 'rgba(238, 238, 238, 0.3)', // md-grey-200
+  };
 }