@jupyterlite/terminal 0.2.0 → 0.2.2

package/README.md

@@ -24,7 +24,7 @@ pip install jupyterlite-terminal
 You will also need to install the JupyterLite CLI:
 
 ```bash
-python -m pip install --pre jupyterlite-core
+python -m pip install jupyterlite-core
 ```
 
 ## Usage

package/lib/client.d.ts

@@ -17,10 +17,14 @@ export declare class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     readonly serverSettings: ServerConnection.ISettings;
     startNew(options?: Terminal.ITerminal.IOptions): Promise<Terminal.IModel>;
     listRunning(): Promise<Terminal.IModel[]>;
+    registerAlias(key: string, value: string): void;
+    registerEnvironmentVariable(key: string, value: string | undefined): void;
     registerExternalCommand(options: IExternalCommand.IOptions): void;
     shutdown(name: string): Promise<void>;
     private get _models();
     private _nextAvailableName;
+    private _aliases?;
+    private _environment?;
     private _browsingContextId?;
     private _externalCommands;
     private _shellManager;

package/lib/client.js

@@ -39,6 +39,9 @@ export class LiteTerminalAPIClient {
             baseUrl,
             wasmBaseUrl: URLExt.join(baseUrl, 'extensions/@jupyterlite/terminal/static/wasm/'),
             browsingContextId: this._browsingContextId,
+            aliases: this._aliases,
+            environment: this._environment,
+            externalCommands: this._externalCommands,
             shellId: name,
             shellManager: this._shellManager,
             outputCallback: text => {
@@ -48,9 +51,6 @@ export class LiteTerminalAPIClient {
             }
         });
         this._shells.set(name, shell);
-        for (const externalCommand of this._externalCommands) {
-            shell.registerExternalCommand(externalCommand);
-        }
         // Hook to connect socket to shell.
         const hook = async (shell, socket) => {
             shell.socket = socket;
@@ -89,6 +89,18 @@ export class LiteTerminalAPIClient {
     async listRunning() {
         return this._models;
     }
+    registerAlias(key, value) {
+        if (this._aliases === undefined) {
+            this._aliases = {};
+        }
+        this._aliases[key] = value;
+    }
+    registerEnvironmentVariable(key, value) {
+        if (this._environment === undefined) {
+            this._environment = {};
+        }
+        this._environment[key] = value;
+    }
     registerExternalCommand(options) {
         this._externalCommands.push(options);
     }

package/lib/index.d.ts

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

package/lib/index.js

@@ -65,3 +65,5 @@ export default [
     terminalManagerPlugin,
     terminalServiceWorkerPlugin
 ];
+// Export ILiteTerminalAPIClient so that other extensions can register external commands.
+export { ILiteTerminalAPIClient };

package/lib/tokens.d.ts

@@ -11,6 +11,17 @@ export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
      * Function that handles stdin requests received from service worker.
      */
     handleStdin(request: IStdinRequest): Promise<IStdinReply>;
+    /**
+     * Register an alias that will be available in all terminals.
+     * If the key has already been registered, it will be overwritten.
+     */
+    registerAlias(key: string, value: string): void;
+    /**
+     * Register an environment variable that will be available in all terminals.
+     * If the key has already been registered, it will be overwritten.
+     * A key with an undefined value will be deleted if already registered.
+     */
+    registerEnvironmentVariable(key: string, value: string | undefined): void;
     /**
      * Register an external command that will be available in all terminals.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@jupyterlite/terminal",
-    "version": "0.2.0",
+    "version": "0.2.2",
     "description": "A terminal for JupyterLite",
     "keywords": [
         "jupyter",
@@ -61,9 +61,9 @@
     "dependencies": {
         "@jupyterlab/coreutils": "^6.4.3",
         "@jupyterlab/services": "^7.4.3",
-        "@jupyterlite/cockle": "^0.1.0",
-        "@jupyterlite/contents": "0.6.0",
-        "@jupyterlite/server": "0.6.0",
+        "@jupyterlite/cockle": "^0.1.2",
+        "@jupyterlite/contents": "^0.6.0",
+        "@jupyterlite/server": "^0.6.0",
         "@lumino/coreutils": "^2.2.0",
         "mock-socket": "^9.3.1"
     },
@@ -110,7 +110,17 @@
     },
     "jupyterlab": {
         "extension": true,
-        "outputDir": "jupyterlite_terminal/labextension"
+        "outputDir": "jupyterlite_terminal/labextension",
+        "sharedPackages": {
+            "@jupyterlite/contents": {
+                "bundled": false,
+                "singleton": true
+            },
+            "@jupyterlite/server": {
+                "bundled": false,
+                "singleton": true
+            }
+        }
     },
     "eslintIgnore": [
         "node_modules",

package/src/client.ts

@@ -60,6 +60,9 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
         'extensions/@jupyterlite/terminal/static/wasm/'
       ),
       browsingContextId: this._browsingContextId,
+      aliases: this._aliases,
+      environment: this._environment,
+      externalCommands: this._externalCommands,
       shellId: name,
       shellManager: this._shellManager,
       outputCallback: text => {
@@ -69,10 +72,6 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     });
     this._shells.set(name, shell);
 
-    for (const externalCommand of this._externalCommands) {
-      shell.registerExternalCommand(externalCommand);
-    }
-
     // Hook to connect socket to shell.
     const hook = async (
       shell: Shell,
@@ -121,6 +120,20 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     return this._models;
   }
 
+  registerAlias(key: string, value: string): void {
+    if (this._aliases === undefined) {
+      this._aliases = {};
+    }
+    this._aliases[key] = value;
+  }
+
+  registerEnvironmentVariable(key: string, value: string | undefined): void {
+    if (this._environment === undefined) {
+      this._environment = {};
+    }
+    this._environment[key] = value;
+  }
+
   registerExternalCommand(options: IExternalCommand.IOptions): void {
     this._externalCommands.push(options);
   }
@@ -150,6 +163,8 @@ export class LiteTerminalAPIClient implements ILiteTerminalAPIClient {
     }
   }
 
+  private _aliases?: { [key: string]: string };
+  private _environment?: { [key: string]: string | undefined };
   private _browsingContextId?: string;
   private _externalCommands: IExternalCommand.IOptions[] = [];
   private _shellManager: IShellManager;

package/src/index.ts

@@ -99,3 +99,6 @@ export default [
   terminalManagerPlugin,
   terminalServiceWorkerPlugin
 ];
+
+// Export ILiteTerminalAPIClient so that other extensions can register external commands.
+export { ILiteTerminalAPIClient };

package/src/tokens.ts

@@ -21,6 +21,19 @@ export interface ILiteTerminalAPIClient extends Terminal.ITerminalAPIClient {
    */
   handleStdin(request: IStdinRequest): Promise<IStdinReply>;
 
+  /**
+   * Register an alias that will be available in all terminals.
+   * If the key has already been registered, it will be overwritten.
+   */
+  registerAlias(key: string, value: string): void;
+
+  /**
+   * Register an environment variable that will be available in all terminals.
+   * If the key has already been registered, it will be overwritten.
+   * A key with an undefined value will be deleted if already registered.
+   */
+  registerEnvironmentVariable(key: string, value: string | undefined): void;
+
   /**
    * Register an external command that will be available in all terminals.
    */