@jupyterlite/terminal 1.0.1 → 1.2.0

package/README.md

@@ -1,7 +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-terminal.vercel.app/)
+[![lite-badge](https://jupyterlite.rtfd.io/en/latest/_static/badge.svg)](https://jupyterlite.github.io/terminal/)
 
 A terminal for JupyterLite.
 
@@ -11,7 +11,7 @@ A terminal for JupyterLite.
 
 ## Requirements
 
-- JupyterLite >= 0.6.0
+- JupyterLite >= 0.7.0, < 0.8.0
 
 ## Install
 
@@ -52,10 +52,12 @@ Each `jupyterlite-terminal` release is built against a specific version of `cock
 include imports from both `jupyterlite-terminal` and `cockle`, such as if you are implementing
 `cockle` external commands, you should ensure that you are using the correct version combination.
 
-| `jupyterlite-terminal` | `cockle` | `jupyterlite-core` |
-| ---------------------- | -------- | ------------------ |
-| 1.0.0                  | 1.0.0    | >= 0.6, < 0.7      |
-| 0.2.2                  | 0.1.3    | >= 0.6, < 0.7      |
+| `jupyterlite-terminal` | `cockle` | `jupyterlite-core` | Release date |
+| ---------------------- | -------- | ------------------ | ------------ |
+| 1.1.0                  | 1.2.0    | >= 0.6, < 0.8      | 2025-10-27   |
+| 1.0.1                  | 1.0.0    | >= 0.6, < 0.8      | 2025-09-03   |
+| 1.0.0                  | 1.0.0    | >= 0.6, < 0.7      | 2025-08-11   |
+| 0.2.2                  | 0.1.3    | >= 0.6, < 0.7      | 2025-06-27   |
 
 ## Contributing
 
@@ -118,6 +120,25 @@ or:
 jupyter lite serve --LiteBuildConfig.extra_http_headers=Cross-Origin-Embedder-Policy=require-corp --LiteBuildConfig.extra_http_headers=Cross-Origin-Opener-Policy=same-origin
 ```
 
+### Building the documentation
+
+The project documentation includes a demo deployment, and is built on every PR so that the changes can be checked manually before merging. To build the documentation and demo locally use:
+
+```bash
+micromamba create -f docs/environment-docs.yml
+micromamba activate terminal-docs
+pip install -v .
+cd docs
+make html
+```
+
+To serve this locally use:
+
+```bash
+cd _build/html
+python -m http.server
+```
+
 ### Packaging the extension
 
 See [RELEASE](RELEASE.md)

package/lib/client.d.ts

@@ -1,6 +1,8 @@
-import { ServerConnection, Terminal } from '@jupyterlab/services';
-import { IExternalCommand, IStdinReply, IStdinRequest } from '@jupyterlite/cockle';
-import { ILiteTerminalAPIClient } from './tokens';
+import type { Terminal } from '@jupyterlab/services';
+import { ServerConnection } from '@jupyterlab/services';
+import type { IExternalCommand, IStdinReply, IStdinRequest } from '@jupyterlite/cockle';
+import type { ISignal } from '@lumino/signaling';
+import type { ILiteTerminalAPIClient } from './tokens';
 export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     constructor(options?: {
         serverSettings?: ServerConnection.ISettings;
@@ -21,6 +23,7 @@ export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     registerEnvironmentVariable(key: string, value: string | undefined): void;
     registerExternalCommand(options: IExternalCommand.IOptions): void;
     shutdown(name: string): Promise<void>;
+    get terminalDisposed(): ISignal<this, string>;
     themeChange(isDarkMode?: boolean): void;
     private get _models();
     private _nextAvailableName;
@@ -30,4 +33,5 @@ export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     private _externalCommands;
     private _shellManager;
     private _shells;
+    private _terminalDisposed;
 }

package/lib/client.js

@@ -1,6 +1,7 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import { ShellManager } from '@jupyterlite/cockle';
+import { Signal } from '@lumino/signaling';
 import { Server as WebSocketServer } from 'mock-socket';
 import { Shell } from './shell';
 export class LiteTerminalAPIClient {
@@ -8,6 +9,7 @@ export class LiteTerminalAPIClient {
         var _a;
         this._externalCommands = [];
         this._shells = new Map();
+        this._terminalDisposed = new Signal(this);
         this.serverSettings =
             (_a = options.serverSettings) !== null && _a !== void 0 ? _a : ServerConnection.makeSettings();
         this._shellManager = new ShellManager();
@@ -83,6 +85,7 @@ export class LiteTerminalAPIClient {
         shell.disposed.connect(() => {
             this.shutdown(name);
             wsServer.close();
+            this._terminalDisposed.emit(shell.shellId);
         });
         return { name };
     }
@@ -114,11 +117,12 @@ export class LiteTerminalAPIClient {
             shell.dispose();
         }
     }
+    get terminalDisposed() {
+        return this._terminalDisposed;
+    }
     themeChange(isDarkMode) {
         for (const shell of this._shells.values()) {
-            // Can pass isDarkMode when cockle is released with PR #232.
-            //shell.themeChange(isDarkMode);
-            shell.themeChange();
+            shell.themeChange(isDarkMode);
         }
     }
     get _models() {

package/lib/index.d.ts

@@ -1,5 +1,5 @@
-import { JupyterFrontEndPlugin } from '@jupyterlab/application';
-import { ServiceManagerPlugin, Terminal } from '@jupyterlab/services';
+import type { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import type { ServiceManagerPlugin, Terminal } from '@jupyterlab/services';
 import { ILiteTerminalAPIClient } from './tokens';
 declare const _default: (ServiceManagerPlugin<Terminal.ITerminalAPIClient> | ServiceManagerPlugin<Terminal.IManager> | JupyterFrontEndPlugin<void>)[];
 export default _default;

package/lib/index.js

@@ -2,7 +2,7 @@
 // Distributed under the terms of the Modified BSD License.
 import { IThemeManager } from '@jupyterlab/apputils';
 import { IServerSettings, ITerminalManager, ServerConnection, TerminalManager } from '@jupyterlab/services';
-import { IServiceWorkerManager } from '@jupyterlite/server';
+import { IServiceWorkerManager } from '@jupyterlite/apputils';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { WebSocket } from 'mock-socket';
 import { LiteTerminalAPIClient } from './client';

package/lib/shell.d.ts

@@ -1,5 +1,6 @@
-import { BaseShell, IShell } from '@jupyterlite/cockle';
-import { Client as WebSocketClient } from 'mock-socket';
+import type { IShell } from '@jupyterlite/cockle';
+import { BaseShell } from '@jupyterlite/cockle';
+import type { Client as WebSocketClient } from 'mock-socket';
 /**
  * Shell class that uses web worker that plugs into a DriveFS via the service worker.
  */

package/lib/tokens.d.ts

@@ -1,6 +1,7 @@
-import { Terminal } from '@jupyterlab/services';
-import { IExternalCommand, IStdinReply, IStdinRequest } from '@jupyterlite/cockle';
+import type { Terminal } from '@jupyterlab/services';
+import type { IExternalCommand, IStdinReply, IStdinRequest } from '@jupyterlite/cockle';
 import { Token } from '@lumino/coreutils';
+import type { ISignal } from '@lumino/signaling';
 export declare const ILiteTerminalAPIClient: Token<ILiteTerminalAPIClient>;
 export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
     /**
@@ -26,6 +27,11 @@ export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
      * Register an external command that will be available in all terminals.
      */
     registerExternalCommand(options: IExternalCommand.IOptions): void;
+    /**
+     * Signal emitted when a terminal is disposed.
+     * The string argument is the terminal `name` which is the same as the Shell's `shellId`.
+     */
+    terminalDisposed: ISignal<this, string>;
     /**
      * Inform all terminals that the theme has changed so that they can react to it if they wish.
      */

package/lib/worker.js

@@ -1,6 +1,6 @@
 import { expose } from 'comlink';
 import { BaseShellWorker } from '@jupyterlite/cockle';
-import { DriveFS } from '@jupyterlite/contents';
+import { DriveFS } from '@jupyterlite/services';
 /**
  * Shell web worker that uses DriveFS via service worker.
  * Note that this is not exported as it is accessed from Shell via the filename.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jupyterlite/terminal",
-    "version": "1.0.1",
+    "version": "1.2.0",
     "description": "A terminal for JupyterLite",
     "keywords": [
         "jupyter",
@@ -59,19 +59,21 @@
         "watch:labextension": "jupyter labextension watch ."
     },
     "dependencies": {
-        "@jupyterlab/apputils": "^4.5.3",
-        "@jupyterlab/coreutils": "^6.4.3",
-        "@jupyterlab/services": "^7.4.3",
-        "@jupyterlab/settingregistry": "^4.4.3",
-        "@jupyterlite/cockle": "^1.0.0",
-        "@jupyterlite/contents": "^0.6.0",
-        "@jupyterlite/server": "^0.6.0",
-        "@lumino/coreutils": "^2.2.0",
+        "@jupyterlab/apputils": "^4.6.0",
+        "@jupyterlab/coreutils": "^6.5.0",
+        "@jupyterlab/pluginmanager": "^4.5.0",
+        "@jupyterlab/services": "^7.5.0",
+        "@jupyterlab/settingregistry": "^4.5.0",
+        "@jupyterlite/apputils": "^0.7.0",
+        "@jupyterlite/cockle": "^1.3.0",
+        "@jupyterlite/services": "^0.7.0",
+        "@lumino/coreutils": "^2.2.1",
+        "@lumino/signaling": "^2.1.4",
         "mock-socket": "^9.3.1"
     },
     "devDependencies": {
-        "@jupyterlab/builder": "^4.4.3",
-        "@jupyterlab/testutils": "^4.4.3",
+        "@jupyterlab/builder": "^4.5.0",
+        "@jupyterlab/testutils": "^4.5.0",
         "@types/jest": "^29.2.0",
         "@types/json-schema": "^7.0.11",
         "@types/react": "^18.0.26",
@@ -122,11 +124,11 @@
                 "bundled": false,
                 "singleton": true
             },
-            "@jupyterlite/contents": {
+            "@jupyterlite/apputils": {
                 "bundled": false,
                 "singleton": true
             },
-            "@jupyterlite/server": {
+            "@jupyterlite/services": {
                 "bundled": false,
                 "singleton": true
             }
@@ -157,6 +159,13 @@
             "@typescript-eslint"
         ],
         "rules": {
+            "@typescript-eslint/consistent-type-imports": [
+                "error",
+                {
+                    "prefer": "type-imports",
+                    "fixStyle": "separate-type-imports"
+                }
+            ],
             "@typescript-eslint/naming-convention": [
                 "error",
                 {

package/src/client.ts

@@ -1,21 +1,22 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
-import { ServerConnection, Terminal } from '@jupyterlab/services';
-import {
+import type { Terminal } from '@jupyterlab/services';
+import { ServerConnection } from '@jupyterlab/services';
+import type {
   IExternalCommand,
   IShellManager,
   IStdinReply,
-  IStdinRequest,
-  ShellManager
+  IStdinRequest
 } from '@jupyterlite/cockle';
-import { JSONPrimitive } from '@lumino/coreutils';
+import { ShellManager } from '@jupyterlite/cockle';
+import type { JSONPrimitive } from '@lumino/coreutils';
+import type { ISignal } from '@lumino/signaling';
+import { Signal } from '@lumino/signaling';
 
-import {
-  Server as WebSocketServer,
-  Client as WebSocketClient
-} from 'mock-socket';
+import type { Client as WebSocketClient } from 'mock-socket';
+import { Server as WebSocketServer } from 'mock-socket';
 
 import { Shell } from './shell';
-import { ILiteTerminalAPIClient } from './tokens';
+import type { ILiteTerminalAPIClient } from './tokens';
 
 export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
   constructor(options: { serverSettings?: ServerConnection.ISettings } = {}) {
@@ -111,6 +112,7 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     shell.disposed.connect(() => {
       this.shutdown(name);
       wsServer.close();
+      this._terminalDisposed.emit(shell.shellId);
     });
 
     return { name };
@@ -148,12 +150,13 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     }
   }
 
+  get terminalDisposed(): ISignal<this, string> {
+    return this._terminalDisposed;
+  }
+
   themeChange(isDarkMode?: boolean): void {
     for (const shell of this._shells.values()) {
-      // Can pass isDarkMode when cockle is released with PR #232.
-      //shell.themeChange(isDarkMode);
-
-      shell.themeChange();
+      shell.themeChange(isDarkMode);
     }
   }
 
@@ -178,4 +181,5 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
   private _externalCommands: IExternalCommand.IOptions[] = [];
   private _shellManager: IShellManager;
   private _shells = new Map<string, Shell>();
+  private _terminalDisposed = new Signal<this, string>(this);
 }

package/src/index.ts

@@ -1,20 +1,19 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 
-import {
+import type {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
 } from '@jupyterlab/application';
 import { IThemeManager } from '@jupyterlab/apputils';
+import type { ServiceManagerPlugin, Terminal } from '@jupyterlab/services';
 import {
   IServerSettings,
   ITerminalManager,
   ServerConnection,
-  ServiceManagerPlugin,
-  Terminal,
   TerminalManager
 } from '@jupyterlab/services';
-import { IServiceWorkerManager } from '@jupyterlite/server';
+import { IServiceWorkerManager } from '@jupyterlite/apputils';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
 import { WebSocket } from 'mock-socket';

package/src/shell.ts

@@ -1,6 +1,7 @@
-import { BaseShell, IShell } from '@jupyterlite/cockle';
+import type { IShell } from '@jupyterlite/cockle';
+import { BaseShell } from '@jupyterlite/cockle';
 
-import { Client as WebSocketClient } from 'mock-socket';
+import type { Client as WebSocketClient } from 'mock-socket';
 
 /**
  * Shell class that uses web worker that plugs into a DriveFS via the service worker.

package/src/tokens.ts

@@ -1,10 +1,11 @@
-import { Terminal } from '@jupyterlab/services';
-import {
+import type { Terminal } from '@jupyterlab/services';
+import type {
   IExternalCommand,
   IStdinReply,
   IStdinRequest
 } from '@jupyterlite/cockle';
 import { Token } from '@lumino/coreutils';
+import type { ISignal } from '@lumino/signaling';
 
 export const ILiteTerminalAPIClient = new Token<ILiteTerminalAPIClient>(
   '@jupyterlite/terminal:client'
@@ -39,6 +40,12 @@ export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
    */
   registerExternalCommand(options: IExternalCommand.IOptions): void;
 
+  /**
+   * Signal emitted when a terminal is disposed.
+   * The string argument is the terminal `name` which is the same as the Shell's `shellId`.
+   */
+  terminalDisposed: ISignal<this, string>;
+
   /**
    * Inform all terminals that the theme has changed so that they can react to it if they wish.
    */

package/src/worker.ts

@@ -1,7 +1,8 @@
 import { expose } from 'comlink';
 
-import { BaseShellWorker, IDriveFSOptions } from '@jupyterlite/cockle';
-import { DriveFS } from '@jupyterlite/contents';
+import type { IDriveFSOptions } from '@jupyterlite/cockle';
+import { BaseShellWorker } from '@jupyterlite/cockle';
+import { DriveFS } from '@jupyterlite/services';
 
 /**
  * Shell web worker that uses DriveFS via service worker.