@jupyterlite/terminal 0.1.0 → 0.1.1

package/README.md

@@ -1,6 +1,7 @@
-# jupyterlite_terminal
+# jupyterlite-terminal
 
 [![Github Actions Status](https://github.com/jupyterlite/terminal/workflows/Build/badge.svg)](https://github.com/jupyterlite/terminal/actions/workflows/build.yml)
+[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/terminal/lab/index.html)
 
 A terminal for JupyterLite.
 

package/lib/index.js

@@ -13,14 +13,14 @@ const terminalsPlugin = {
     activate: async (app) => {
         console.log('JupyterLab extension @jupyterlite/terminal:plugin is activated!');
         const { serviceManager } = app;
-        const { contents, serverSettings, terminals } = serviceManager;
+        const { serverSettings, terminals } = serviceManager;
         console.log('terminals available:', terminals.isAvailable());
         console.log('terminals ready:', terminals.isReady); // Not ready
         console.log('terminals active:', terminals.isActive);
         // Not sure this is necessary?
         await terminals.ready;
         console.log('terminals ready after await:', terminals.isReady); // Ready
-        return new Terminals(serverSettings.wsUrl, contents);
+        return new Terminals(serverSettings.wsUrl);
     }
 };
 /**
@@ -34,7 +34,7 @@ const terminalsRoutesPlugin = {
         console.log('JupyterLab extension @jupyterlite/terminal:routes-plugin is activated!', terminals);
         // GET /api/terminals - List the running terminals
         app.router.get('/api/terminals', async (req) => {
-            const res = terminals.list();
+            const res = await terminals.list();
             // Should return last_activity for each too,
             return new Response(JSON.stringify(res));
         });

package/lib/terminal.d.ts

@@ -1,15 +1,16 @@
 import { ITerminal } from './tokens';
 export declare class Terminal implements ITerminal {
+    readonly options: ITerminal.IOptions;
     /**
      * Construct a new Terminal.
      */
     constructor(options: ITerminal.IOptions);
+    private _outputCallback;
     /**
      * Get the name of the terminal.
      */
     get name(): string;
     wsConnect(url: string): Promise<void>;
-    private _name;
-    private _fs;
-    private _shell?;
+    private _socket?;
+    private _shell;
 }

package/lib/terminal.js

@@ -1,38 +1,41 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { JupyterFileSystem, Shell } from '@jupyterlite/cockle';
+import { Shell } from '@jupyterlite/cockle';
 import { Server as WebSocketServer } from 'mock-socket';
 export class Terminal {
     /**
      * Construct a new Terminal.
      */
     constructor(options) {
-        this._name = options.name;
-        this._fs = new JupyterFileSystem(options.contentsManager);
-        console.log('==> new Terminal', this._name, this._fs);
+        this.options = options;
+        this._shell = new Shell({
+            mountpoint: '/drive',
+            driveFsBaseUrl: options.baseUrl,
+            wasmBaseUrl: options.baseUrl + 'extensions/@jupyterlite/terminal/static/wasm/',
+            outputCallback: this._outputCallback.bind(this)
+        });
+    }
+    async _outputCallback(text) {
+        if (this._socket) {
+            const ret = JSON.stringify(['stdout', text]);
+            this._socket.send(ret);
+        }
     }
     /**
      * Get the name of the terminal.
      */
     get name() {
-        return this._name;
+        return this.options.name;
     }
     async wsConnect(url) {
         console.log('==> Terminal.wsConnect', url);
-        // const server = new WebSocketServer(url, { mock: false });
         const server = new WebSocketServer(url);
         server.on('connection', async (socket) => {
             console.log('==> server connection', this, socket);
-            const outputCallback = async (output) => {
-                console.log('==> recv from shell:', output);
-                const ret = JSON.stringify(['stdout', output]);
-                socket.send(ret);
-            };
-            this._shell = new Shell(this._fs, outputCallback);
-            console.log('==> shell', this._shell);
+            this._socket = socket;
             socket.on('message', async (message) => {
                 const data = JSON.parse(message);
-                console.log('==> socket message', data);
+                //console.log('==> socket message', data);
                 const message_type = data[0];
                 const content = data.slice(1);
                 if (message_type === 'stdin') {

package/lib/terminals.d.ts

@@ -1,4 +1,4 @@
-import { Contents, TerminalAPI } from '@jupyterlab/services';
+import { TerminalAPI } from '@jupyterlab/services';
 import { ITerminals } from './tokens';
 /**
  * A class to handle requests to /api/terminals
@@ -7,7 +7,7 @@ export declare class Terminals implements ITerminals {
     /**
      * Construct a new Terminals object.
      */
-    constructor(wsUrl: string, contentsManager: Contents.IManager);
+    constructor(wsUrl: string);
     /**
      * List the running terminals.
      */
@@ -18,6 +18,5 @@ export declare class Terminals implements ITerminals {
     startNew(): Promise<TerminalAPI.IModel>;
     private _nextAvailableName;
     private _wsUrl;
-    private _contentsManager;
     private _terminals;
 }

package/lib/terminals.js

@@ -1,5 +1,6 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+import { PageConfig } from '@jupyterlab/coreutils';
 import { Terminal } from './terminal';
 /**
  * A class to handle requests to /api/terminals
@@ -8,11 +9,10 @@ export class Terminals {
     /**
      * Construct a new Terminals object.
      */
-    constructor(wsUrl, contentsManager) {
+    constructor(wsUrl) {
         this._terminals = new Map();
         this._wsUrl = wsUrl;
-        this._contentsManager = contentsManager;
-        console.log('==> Terminals.constructor', this._wsUrl, this._contentsManager);
+        console.log('==> Terminals.constructor', this._wsUrl);
     }
     /**
      * List the running terminals.
@@ -30,7 +30,8 @@ export class Terminals {
     async startNew() {
         const name = this._nextAvailableName();
         console.log('==> Terminals.new', name);
-        const term = new Terminal({ name, contentsManager: this._contentsManager });
+        const baseUrl = PageConfig.getBaseUrl();
+        const term = new Terminal({ name, baseUrl });
         this._terminals.set(name, term);
         const url = `${this._wsUrl}terminals/websocket/${name}`;
         await term.wsConnect(url);

package/lib/tokens.d.ts

@@ -1,4 +1,4 @@
-import { Contents, TerminalAPI } from '@jupyterlab/services';
+import { TerminalAPI } from '@jupyterlab/services';
 import { Token } from '@lumino/coreutils';
 /**
  * The token for the Terminals service.
@@ -38,6 +38,6 @@ export declare namespace ITerminal {
          * The name of the terminal.
          */
         name: string;
-        contentsManager: Contents.IManager;
+        baseUrl: string;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jupyterlite/terminal",
-    "version": "0.1.0",
+    "version": "0.1.1",
     "description": "A terminal for JupyterLite",
     "keywords": [
         "jupyter",
@@ -30,12 +30,13 @@
         "url": "https://github.com/jupyterlite/terminal.git"
     },
     "scripts": {
-        "build": "jlpm build:lib && jlpm build:labextension:dev",
-        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
+        "build": "jlpm build:lib && jlpm build:labextension:dev && jlpm build:copywasm",
+        "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension && jlpm build:copywasm",
         "build:labextension": "jupyter labextension build .",
         "build:labextension:dev": "jupyter labextension build --development True .",
         "build:lib": "tsc --sourceMap",
         "build:lib:prod": "tsc",
+        "build:copywasm": "cp -r node_modules/@jupyterlite/cockle/lib/wasm jupyterlite_terminal/labextension/static/",
         "clean": "jlpm clean:lib",
         "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
         "clean:lintcache": "rimraf .eslintcache .stylelintcache",
@@ -57,17 +58,19 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
-        "@jupyterlab/services": "^7.2.0",
-        "@jupyterlab/terminal": "^4.2.0",
-        "@jupyterlab/terminal-extension": "^4.2.0",
-        "@jupyterlite/cockle": "^0.0.3",
-        "@jupyterlite/server": "^0.3.0",
-        "@lumino/coreutils": "^2.1.2",
+        "@jupyterlab/coreutils": "^6.2.4",
+        "@jupyterlab/services": "^7.2.4",
+        "@jupyterlab/terminal": "^4.2.4",
+        "@jupyterlab/terminal-extension": "^4.2.4",
+        "@jupyterlite/cockle": "^0.0.8",
+        "@jupyterlite/contents": "^0.4.0",
+        "@jupyterlite/server": "^0.4.0",
+        "@lumino/coreutils": "^2.2.0",
         "mock-socket": "^9.3.1"
     },
     "devDependencies": {
-        "@jupyterlab/builder": "^4.0.0",
-        "@jupyterlab/testutils": "^4.0.0",
+        "@jupyterlab/builder": "^4.2.4",
+        "@jupyterlab/testutils": "^4.2.4",
         "@types/jest": "^29.2.0",
         "@types/json-schema": "^7.0.11",
         "@types/react": "^18.0.26",
@@ -90,6 +93,8 @@
         "stylelint-csstree-validator": "^3.0.0",
         "stylelint-prettier": "^4.0.0",
         "typescript": "~5.0.2",
+        "webpack": "^5.87.0",
+        "webpack-cli": "^5.1.4",
         "yjs": "^13.5.0"
     },
     "sideEffects": [
@@ -102,7 +107,8 @@
     },
     "jupyterlab": {
         "extension": true,
-        "outputDir": "jupyterlite_terminal/labextension"
+        "outputDir": "jupyterlite_terminal/labextension",
+        "webpackConfig": "./webpack.extra.config.js"
     },
     "jupyterlite": {
         "liteExtension": true

package/src/index.ts

@@ -24,7 +24,7 @@ const terminalsPlugin: JupyterLiteServerPlugin<ITerminals> = {
     );
 
     const { serviceManager } = app;
-    const { contents, serverSettings, terminals } = serviceManager;
+    const { serverSettings, terminals } = serviceManager;
     console.log('terminals available:', terminals.isAvailable());
     console.log('terminals ready:', terminals.isReady); // Not ready
     console.log('terminals active:', terminals.isActive);
@@ -33,7 +33,7 @@ const terminalsPlugin: JupyterLiteServerPlugin<ITerminals> = {
     await terminals.ready;
     console.log('terminals ready after await:', terminals.isReady); // Ready
 
-    return new Terminals(serverSettings.wsUrl, contents);
+    return new Terminals(serverSettings.wsUrl);
   }
 };
 
@@ -52,7 +52,7 @@ const terminalsRoutesPlugin: JupyterLiteServerPlugin<void> = {
 
     // GET /api/terminals - List the running terminals
     app.router.get('/api/terminals', async (req: Router.IRequest) => {
-      const res = terminals.list();
+      const res = await terminals.list();
       // Should return last_activity for each too,
       return new Response(JSON.stringify(res));
     });

package/src/terminal.ts

@@ -1,8 +1,7 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { JupyterFileSystem, Shell, IFileSystem } from '@jupyterlite/cockle';
-
+import { Shell } from '@jupyterlite/cockle';
 import { JSONPrimitive } from '@lumino/coreutils';
 
 import {
@@ -16,49 +15,51 @@ export class Terminal implements ITerminal {
   /**
    * Construct a new Terminal.
    */
-  constructor(options: ITerminal.IOptions) {
-    this._name = options.name;
-    this._fs = new JupyterFileSystem(options.contentsManager);
-    console.log('==> new Terminal', this._name, this._fs);
+  constructor(readonly options: ITerminal.IOptions) {
+    this._shell = new Shell({
+      mountpoint: '/drive',
+      driveFsBaseUrl: options.baseUrl,
+      wasmBaseUrl:
+        options.baseUrl + 'extensions/@jupyterlite/terminal/static/wasm/',
+      outputCallback: this._outputCallback.bind(this)
+    });
+  }
+
+  private async _outputCallback(text: string): Promise<void> {
+    if (this._socket) {
+      const ret = JSON.stringify(['stdout', text]);
+      this._socket.send(ret);
+    }
   }
 
   /**
    * Get the name of the terminal.
    */
   get name(): string {
-    return this._name;
+    return this.options.name;
   }
 
   async wsConnect(url: string) {
     console.log('==> Terminal.wsConnect', url);
 
-    // const server = new WebSocketServer(url, { mock: false });
     const server = new WebSocketServer(url);
 
     server.on('connection', async (socket: WebSocketClient) => {
       console.log('==> server connection', this, socket);
-
-      const outputCallback = async (output: string) => {
-        console.log('==> recv from shell:', output);
-        const ret = JSON.stringify(['stdout', output]);
-        socket.send(ret);
-      };
-
-      this._shell = new Shell(this._fs, outputCallback);
-      console.log('==> shell', this._shell);
+      this._socket = socket;
 
       socket.on('message', async (message: any) => {
         const data = JSON.parse(message) as JSONPrimitive[];
-        console.log('==> socket message', data);
+        //console.log('==> socket message', data);
         const message_type = data[0];
         const content = data.slice(1);
 
         if (message_type === 'stdin') {
-          await this._shell!.input(content[0] as string);
+          await this._shell.input(content[0] as string);
         } else if (message_type === 'set_size') {
           const rows = content[0] as number;
           const columns = content[1] as number;
-          await this._shell!.setSize(rows, columns);
+          await this._shell.setSize(rows, columns);
         }
       });
 
@@ -75,11 +76,10 @@ export class Terminal implements ITerminal {
       console.log('==> Returning handshake via socket', res);
       socket.send(res);
 
-      await this._shell!.start();
+      await this._shell.start();
     });
   }
 
-  private _name: string;
-  private _fs: IFileSystem;
-  private _shell?: Shell;
+  private _socket?: WebSocketClient;
+  private _shell: Shell;
 }

package/src/terminals.ts

@@ -1,7 +1,8 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { Contents, TerminalAPI } from '@jupyterlab/services';
+import { PageConfig } from '@jupyterlab/coreutils';
+import { TerminalAPI } from '@jupyterlab/services';
 
 import { Terminal } from './terminal';
 import { ITerminals } from './tokens';
@@ -13,14 +14,9 @@ export class Terminals implements ITerminals {
   /**
    * Construct a new Terminals object.
    */
-  constructor(wsUrl: string, contentsManager: Contents.IManager) {
+  constructor(wsUrl: string) {
     this._wsUrl = wsUrl;
-    this._contentsManager = contentsManager;
-    console.log(
-      '==> Terminals.constructor',
-      this._wsUrl,
-      this._contentsManager
-    );
+    console.log('==> Terminals.constructor', this._wsUrl);
   }
 
   /**
@@ -40,7 +36,8 @@ export class Terminals implements ITerminals {
   async startNew(): Promise<TerminalAPI.IModel> {
     const name = this._nextAvailableName();
     console.log('==> Terminals.new', name);
-    const term = new Terminal({ name, contentsManager: this._contentsManager });
+    const baseUrl = PageConfig.getBaseUrl();
+    const term = new Terminal({ name, baseUrl });
     this._terminals.set(name, term);
 
     const url = `${this._wsUrl}terminals/websocket/${name}`;
@@ -59,6 +56,5 @@ export class Terminals implements ITerminals {
   }
 
   private _wsUrl: string;
-  private _contentsManager: Contents.IManager;
   private _terminals: Map<string, Terminal> = new Map();
 }

package/src/tokens.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import { Contents, TerminalAPI } from '@jupyterlab/services';
+import { TerminalAPI } from '@jupyterlab/services';
 
 import { Token } from '@lumino/coreutils';
 
@@ -50,6 +50,6 @@ export namespace ITerminal {
      */
     name: string;
 
-    contentsManager: Contents.IManager;
+    baseUrl: string;
   }
 }