@jupyterlite/terminal 0.2.0-a0 → 0.2.0

package/src/manager.ts

@@ -1,207 +0,0 @@
-import { BaseManager, Terminal, TerminalManager } from '@jupyterlab/services';
-import { ISignal, Signal } from '@lumino/signaling';
-import { LiteTerminalConnection } from './terminal';
-
-/**
- * Interface for Lite terminal manager, supports setting browserContextId.
- */
-interface ILiteTerminalManager extends Terminal.IManager {
-  browsingContextId: string;
-}
-
-/**
- * Type guard for ILiteTerminalManager.
- */
-export function isILiteTerminalManager(
-  obj: Terminal.IManager
-): obj is ILiteTerminalManager {
-  return 'browsingContextId' in obj;
-}
-
-/**
- * A terminal session manager.
- */
-export class LiteTerminalManager
-  extends BaseManager
-  implements ILiteTerminalManager
-{
-  /**
-   * Construct a new terminal manager.
-   */
-  constructor(options: TerminalManager.IOptions = {}) {
-    super(options);
-
-    // Initialize internal data.
-    this._ready = (async () => {
-      this._isReady = true;
-    })();
-  }
-
-  /**
-   * Set identifier for communicating with service worker.
-   */
-  set browsingContextId(browsingContextId: string) {
-    console.log('==> LiteTerminalManager browsingContextId', browsingContextId);
-    this._browsingContextId = browsingContextId;
-  }
-
-  /**
-   * A signal emitted when there is a connection failure.
-   */
-  get connectionFailure(): ISignal<this, Error> {
-    return this._connectionFailure;
-  }
-
-  /*
-   * Connect to a running terminal.
-   *
-   * @param options - The options used to connect to the terminal.
-   *
-   * @returns The new terminal connection instance.
-   *
-   * #### Notes
-   * The manager `serverSettings` will be used.
-   */
-  connectTo(
-    options: Omit<Terminal.ITerminalConnection.IOptions, 'serverSettings'>
-  ): Terminal.ITerminalConnection {
-    const { model } = options;
-    const { name } = model;
-    console.log('==> LiteTerminalManager.connectTo', name);
-    const { serverSettings } = this;
-
-    const terminal = new LiteTerminalConnection({
-      browsingContextId: this._browsingContextId,
-      model,
-      serverSettings
-    });
-    terminal.disposed.connect(() => this.shutdown(name));
-    return terminal;
-  }
-
-  /**
-   * Whether the terminal service is available.
-   */
-  isAvailable(): boolean {
-    return true;
-  }
-
-  /**
-   * Test whether the manager is ready.
-   */
-  get isReady(): boolean {
-    return this._isReady;
-  }
-
-  /**
-   * A promise that fulfills when the manager is ready.
-   */
-  get ready(): Promise<void> {
-    return this._ready;
-  }
-
-  /**
-   * Force a refresh of the running terminals.
-   *
-   * @returns A promise that with the list of running terminals.
-   *
-   * #### Notes
-   * This is intended to be called only in response to a user action,
-   * since the manager maintains its internal state.
-   */
-  async refreshRunning(): Promise<void> {
-    this._runningChanged.emit(this._models);
-  }
-
-  /**
-   * Create an iterator over the most recent running terminals.
-   *
-   * @returns A new iterator over the running terminals.
-   */
-  running(): IterableIterator<Terminal.IModel> {
-    return this._models[Symbol.iterator]();
-  }
-
-  /**
-   * A signal emitted when the running terminals change.
-   */
-  get runningChanged(): ISignal<this, Terminal.IModel[]> {
-    return this._runningChanged;
-  }
-
-  /**
-   * Shut down a terminal session by name.
-   */
-  async shutdown(name: string): Promise<void> {
-    const terminal = this._terminalConnections.get(name);
-    if (terminal !== undefined) {
-      this._terminalConnections.delete(name);
-      terminal.dispose();
-      this.refreshRunning();
-    }
-  }
-
-  /**
-   * Shut down all terminal sessions.
-   *
-   * @returns A promise that resolves when all of the sessions are shut down.
-   */
-  async shutdownAll(): Promise<void> {
-    await Promise.all(this._models.map(model => this.shutdown(model.name)));
-    this.refreshRunning();
-  }
-
-  /**
-   * 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 used unless overridden in the
-   * options.
-   */
-  async startNew(
-    options: Terminal.ITerminal.IOptions
-  ): Promise<Terminal.ITerminalConnection> {
-    const name = options.name ?? this._nextAvailableName();
-    const model: Terminal.IModel = { name };
-    const { serverSettings } = this;
-
-    const terminal = new LiteTerminalConnection({
-      browsingContextId: this._browsingContextId,
-      model,
-      serverSettings
-    });
-    terminal.disposed.connect(() => this.shutdown(name));
-    this._terminalConnections.set(name, terminal);
-    await this.refreshRunning();
-    return terminal;
-  }
-
-  private get _models(): Terminal.IModel[] {
-    return Array.from(this._terminalConnections, ([name, value]) => {
-      return { name };
-    });
-  }
-
-  private _nextAvailableName(): string {
-    for (let i = 1; ; ++i) {
-      const name = `${i}`;
-      if (!this._terminalConnections.has(name)) {
-        return name;
-      }
-    }
-  }
-
-  private _browsingContextId?: string;
-  private _connectionFailure = new Signal<this, Error>(this);
-  private _isReady = false;
-  private _ready: Promise<void>;
-  private _runningChanged = new Signal<this, Terminal.IModel[]>(this);
-  private _terminalConnections = new Map<
-    string,
-    Terminal.ITerminalConnection
-  >();
-}

package/src/terminal.ts

@@ -1,195 +0,0 @@
-import { ServerConnection, Terminal } from '@jupyterlab/services';
-import { ISignal, Signal } from '@lumino/signaling';
-import { Shell } from './shell';
-import { IShell } from '@jupyterlite/cockle';
-
-/**
- * An implementation of a terminal interface.
- */
-export class LiteTerminalConnection implements Terminal.ITerminalConnection {
-  /**
-   * Construct a new terminal session.
-   */
-  constructor(options: LiteTerminalConnection.IOptions) {
-    this._name = options.model.name;
-    this._serverSettings = options.serverSettings!;
-    const { baseUrl } = this._serverSettings;
-    const { browsingContextId } = options;
-
-    this._shell = new Shell({
-      mountpoint: '/drive',
-      driveFsBaseUrl: baseUrl,
-      wasmBaseUrl: baseUrl + 'extensions/@jupyterlite/terminal/static/wasm/',
-      outputCallback: this._outputCallback.bind(this),
-      browsingContextId
-    });
-    this._shell.disposed.connect(() => this.dispose());
-
-    this._shell.start().then(() => this._updateConnectionStatus('connected'));
-  }
-
-  /**
-   * The current connection status of the terminal connection.
-   */
-  get connectionStatus(): Terminal.ConnectionStatus {
-    return this._connectionStatus;
-  }
-
-  /**
-   * A signal emitted when the terminal connection status changes.
-   */
-  get connectionStatusChanged(): ISignal<this, Terminal.ConnectionStatus> {
-    return this._connectionStatusChanged;
-  }
-
-  /**
-   * Dispose of the resources held by the session.
-   */
-  dispose(): void {
-    if (this._isDisposed) {
-      return;
-    }
-
-    this._isDisposed = true;
-    this._shell.dispose();
-    this._disposed.emit();
-
-    this._updateConnectionStatus('disconnected');
-
-    Signal.clearData(this);
-  }
-
-  /**
-   * A signal emitted when the session is disposed.
-   */
-  get disposed(): ISignal<this, void> {
-    return this._disposed;
-  }
-
-  /**
-   * Test whether the session is disposed.
-   */
-  get isDisposed(): boolean {
-    return this._isDisposed;
-  }
-
-  /**
-   * A signal emitted when a message is received from the server.
-   */
-  get messageReceived(): ISignal<
-    Terminal.ITerminalConnection,
-    Terminal.IMessage
-  > {
-    return this._messageReceived;
-  }
-
-  /**
-   * Get the model for the terminal session.
-   */
-  get model(): Terminal.IModel {
-    return { name: this._name };
-  }
-
-  /**
-   * Get the name of the terminal session.
-   */
-  get name(): string {
-    return this._name;
-  }
-
-  /**
-   * Reconnect to a terminal.
-   *
-   * #### Notes
-   * This may try multiple times to reconnect to a terminal, and will sever
-   * any existing connection.
-   */
-  async reconnect(): Promise<void> {
-    console.log('==> LiteTerminalConnection.reconnect not implemented');
-  }
-
-  /**
-   * Send a message to the terminal session.
-   *
-   * #### Notes
-   * If the connection is down, the message will be queued for sending when
-   * the connection comes back up.
-   */
-  send(message: Terminal.IMessage): void {
-    const { content } = message;
-    if (content === undefined) {
-      return;
-    }
-
-    switch (message.type) {
-      case 'stdin':
-        this._shell.input(content[0] as string); // async
-        break;
-      case 'set_size': {
-        const rows = content[0] as number;
-        const columns = content[1] as number;
-        this._shell.setSize(rows, columns); // async
-        break;
-      }
-    }
-  }
-
-  /**
-   * The server settings for the session.
-   */
-  get serverSettings(): ServerConnection.ISettings {
-    return this._serverSettings;
-  }
-
-  /**
-   * Shut down the terminal session.
-   */
-  async shutdown(): Promise<void> {
-    this.dispose();
-  }
-
-  private _outputCallback(text: string): void {
-    // 'stdout' or 'disconnect' as MessageType.
-    // Cockle is not yet using the 'disconnect'.
-    this._messageReceived.emit({ type: 'stdout', content: [text] });
-  }
-
-  /**
-   * Handle connection status changes.
-   */
-  private _updateConnectionStatus(
-    connectionStatus: Terminal.ConnectionStatus
-  ): void {
-    if (this._connectionStatus === connectionStatus) {
-      return;
-    }
-
-    this._connectionStatus = connectionStatus;
-
-    // Notify others that the connection status changed.
-    this._connectionStatusChanged.emit(connectionStatus);
-  }
-
-  private _isDisposed = false;
-  private _disposed = new Signal<this, void>(this);
-
-  private _name: string;
-  private _serverSettings: ServerConnection.ISettings;
-  private _connectionStatus: Terminal.ConnectionStatus = 'connecting';
-  private _connectionStatusChanged = new Signal<
-    this,
-    Terminal.ConnectionStatus
-  >(this);
-  private _messageReceived = new Signal<this, Terminal.IMessage>(this);
-
-  private _shell: IShell;
-}
-
-export namespace LiteTerminalConnection {
-  export interface IOptions extends Terminal.ITerminalConnection.IOptions {
-    /**
-     * The ID of the browsing context where the request originated.
-     */
-    browsingContextId?: string;
-  }
-}