jupyterlab_commands_extension 1.1.4 → 1.1.7

package/README.md

@@ -61,11 +61,13 @@ jupyterlab-commands activity
 jupyterlab-commands execute file:download --args '{"path": "data/report.csv"}'
 ```
 
+The optional `--purpose` flag names the purpose of an execution in at most 25 words, and the optional `--owner` flag names the agent or project that asked for it. The CLI treats both as optional; the agent skill requires them. An empty value, or a purpose over 25 words, is a usage error.
+
 Exit codes: 0 success, 2 discovery or usage error, 3 no browser client, 4 command not allowed, 5 execution error.
 
 The browser tab is the executor: the command runs in the lab, not in the terminal.
 
-Every execute request reaches the JupyterLab server log: the outcome, the command ID, the arguments as compact JSON truncated to 500 characters, the elapsed milliseconds and the caller's remote IP, at INFO on success and WARNING on refusal or failure.
+Every execute request reaches the JupyterLab server log: the outcome, the command ID, the arguments as compact JSON truncated to 500 characters, the elapsed milliseconds, the caller's remote IP, and the purpose and owner when given, at INFO on success and WARNING on refusal or failure.
 
 ## Allowlist
 

package/lib/index.js

@@ -1,8 +1,9 @@
 import { ICommandPalette, MainAreaWidget } from '@jupyterlab/apputils';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { textEditorIcon } from '@jupyterlab/ui-components';
+// eslint-disable-next-line jupyter/prefer-lazy-imports -- the relay must start with the plugin: the CLI reaches this tab only through it
 import { RelayClient } from './relay';
-import { CommandsReferenceWidget } from './widget';
 /**
  * Command IDs for the extension
  */
@@ -30,8 +31,9 @@ const plugin = {
     id: PLUGIN_ID,
     description: 'Display all available JupyterLab commands with their full reference IDs and arguments in a dedicated tab',
     autoStart: true,
-    requires: [ICommandPalette, ISettingRegistry],
-    activate: async (app, palette, settingRegistry) => {
+    requires: [ICommandPalette, ISettingRegistry, ITranslator],
+    activate: async (app, palette, settingRegistry, translator) => {
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyterlab_commands_extension');
         console.log('JupyterLab extension jupyterlab_commands_extension is activated!');
         let settings = null;
         try {
@@ -42,15 +44,17 @@ const plugin = {
         }
         // Register the command
         app.commands.addCommand(CommandIDs.open, {
-            label: 'Show Commands Reference',
-            caption: 'Display all available JupyterLab commands with their IDs and arguments',
-            execute: () => {
+            label: trans.__('Show Commands Reference'),
+            caption: trans.__('Display all available JupyterLab commands with their IDs and arguments'),
+            describedBy: () => ({}),
+            execute: async () => {
                 // Create widget if it doesn't exist or was disposed
                 if (!widget || widget.isDisposed) {
-                    const content = new CommandsReferenceWidget(app.commands, settings, settingRegistry);
+                    const { CommandsReferenceWidget } = await import('./widget');
+                    const content = new CommandsReferenceWidget(app.commands, settings, settingRegistry, trans);
                     widget = new MainAreaWidget({ content });
                     widget.id = 'jp-commands-reference';
-                    widget.title.label = 'Commands Reference';
+                    widget.title.label = trans.__('Commands Reference');
                     widget.title.icon = textEditorIcon;
                     widget.title.closable = true;
                     // Clear reference when widget is disposed
@@ -69,13 +73,13 @@ const plugin = {
         // Add command to palette under Help category
         palette.addItem({
             command: CommandIDs.open,
-            category: 'Help'
+            category: trans.__('Help')
         });
         // Download a file the contents API serves to the computer that runs
         // the browser tab.
         app.commands.addCommand(CommandIDs.download, {
-            label: 'Download File',
-            caption: 'Download a file from the server to the local computer',
+            label: trans.__('Download File'),
+            caption: trans.__('Download a file from the server to the local computer'),
             describedBy: () => ({
                 args: {
                     type: 'object',

package/lib/relay.js

@@ -1,4 +1,4 @@
-import { PageConfig, URLExt } from '@jupyterlab/coreutils';
+import { URLExt } from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import { getAllowedCommands } from './allowlist';
 import { collectCommandDescriptors } from './commands';
@@ -228,7 +228,7 @@ export class RelayClient {
      * Build the URL of one relay endpoint.
      */
     _url(endpoint) {
-        return URLExt.join(PageConfig.getBaseUrl(), API_NAMESPACE, 'api', endpoint);
+        return URLExt.join(this._serverSettings.baseUrl, API_NAMESPACE, 'api', endpoint);
     }
     _get(endpoint) {
         const url = this._url(endpoint) + '?client_id=' + encodeURIComponent(this._clientId);

package/lib/widget.d.ts

@@ -1,6 +1,7 @@
 import { Widget } from '@lumino/widgets';
 import { CommandRegistry } from '@lumino/commands';
 import type { ISettingRegistry } from '@jupyterlab/settingregistry';
+import type { TranslationBundle } from '@jupyterlab/translation';
 /**
  * A widget that displays all registered JupyterLab commands
  */
@@ -13,7 +14,8 @@ export declare class CommandsReferenceWidget extends Widget {
     private _tbody;
     private _commandsCache;
     private _argsCache;
-    constructor(commands: CommandRegistry, settings?: ISettingRegistry.ISettings | null, registry?: ISettingRegistry | null);
+    private _trans;
+    constructor(commands: CommandRegistry, settings?: ISettingRegistry.ISettings | null, registry?: ISettingRegistry | null, trans?: TranslationBundle);
     /**
      * Dispose the widget and drop the settings listener.
      */

package/lib/widget.js

@@ -1,17 +1,19 @@
 import { Widget } from '@lumino/widgets';
+import { nullTranslator } from '@jupyterlab/translation';
 import { addAllowedCommand, getAllowedCommands } from './allowlist';
 import { collectCommands, describeCommand } from './commands';
 /**
  * A widget that displays all registered JupyterLab commands
  */
 export class CommandsReferenceWidget extends Widget {
-    constructor(commands, settings = null, registry = null) {
+    constructor(commands, settings = null, registry = null, trans = nullTranslator.load('jupyterlab_commands_extension')) {
         super();
         this._commandsCache = [];
         this._argsCache = new Map();
         this._commands = commands;
         this._settings = settings;
         this._registry = registry;
+        this._trans = trans;
         this.addClass('jp-CommandsReferenceWidget');
         if (this._settings) {
             this._settings.changed.connect(this._onSettingsChanged, this);
@@ -46,7 +48,7 @@ export class CommandsReferenceWidget extends Widget {
         // Search input
         this._searchInput = document.createElement('input');
         this._searchInput.type = 'text';
-        this._searchInput.placeholder = 'Filter commands...';
+        this._searchInput.placeholder = this._trans.__('Filter commands...');
         this._searchInput.className =
             'jp-CommandsReferenceWidget-search jp-mod-styled';
         this._searchInput.addEventListener('input', () => {
@@ -71,11 +73,11 @@ export class CommandsReferenceWidget extends Widget {
         const thead = document.createElement('thead');
         const headerRow = document.createElement('tr');
         const headers = [
-            'Command ID',
-            'Label',
-            'Description',
-            'Arguments',
-            'Command Executor'
+            this._trans.__('Command ID'),
+            this._trans.__('Label'),
+            this._trans.__('Description'),
+            this._trans.__('Arguments'),
+            this._trans.__('Command Executor')
         ];
         for (const headerText of headers) {
             const th = document.createElement('th');
@@ -187,11 +189,11 @@ export class CommandsReferenceWidget extends Widget {
                 void this._addToExecutor(cmd.id, button);
             });
             if (this._isAllowed(cmd.id)) {
-                button.textContent = 'Added';
+                button.textContent = this._trans.__('Added');
                 button.disabled = true;
             }
             else {
-                button.textContent = 'Add to command executor';
+                button.textContent = this._trans.__('Add to command executor');
                 button.disabled = !this._settings || !this._registry;
             }
             executorCell.appendChild(button);
@@ -233,11 +235,11 @@ export class CommandsReferenceWidget extends Widget {
         button.disabled = true;
         try {
             await addAllowedCommand(this._settings, this._registry, commandId);
-            button.textContent = 'Added';
+            button.textContent = this._trans.__('Added');
         }
         catch (error) {
             console.error('Commands Reference: cannot update allowedCommands', error);
-            button.textContent = 'Add to command executor';
+            button.textContent = this._trans.__('Add to command executor');
             button.disabled = false;
         }
     }
@@ -249,7 +251,9 @@ export class CommandsReferenceWidget extends Widget {
         for (const button of Array.from(buttons)) {
             const commandId = button.dataset.commandId || '';
             const allowed = this._isAllowed(commandId);
-            button.textContent = allowed ? 'Added' : 'Add to command executor';
+            button.textContent = allowed
+                ? this._trans.__('Added')
+                : this._trans.__('Add to command executor');
             button.disabled =
                 allowed || this._settings === null || this._registry === null;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jupyterlab_commands_extension",
-    "version": "1.1.4",
+    "version": "1.1.7",
     "description": "Display all available JupyterLab commands with their full reference IDs and arguments in a dedicated tab",
     "keywords": [
         "jupyter",
@@ -62,6 +62,7 @@
         "@jupyterlab/coreutils": "^6.6.0",
         "@jupyterlab/services": "^7.6.0",
         "@jupyterlab/settingregistry": "^4.6.0",
+        "@jupyterlab/translation": "^4.6.4",
         "@jupyterlab/ui-components": "^4.6.0"
     },
     "devDependencies": {

package/schema/plugin.json

@@ -22,7 +22,8 @@
         "terminal:create-new",
         "launcher:create",
         "jupyterlab-commands-reference:open",
-        "file:download"
+        "file:download",
+        "workspace-ui:open"
       ]
     }
   },

package/src/index.ts

@@ -7,10 +7,13 @@ import { ICommandPalette, MainAreaWidget } from '@jupyterlab/apputils';
 
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+
 import { textEditorIcon } from '@jupyterlab/ui-components';
 
+// eslint-disable-next-line jupyter/prefer-lazy-imports -- the relay must start with the plugin: the CLI reaches this tab only through it
 import { RelayClient } from './relay';
-import { CommandsReferenceWidget } from './widget';
+import type { CommandsReferenceWidget } from './widget';
 
 /**
  * Command IDs for the extension
@@ -43,12 +46,17 @@ const plugin: JupyterFrontEndPlugin<void> = {
   description:
     'Display all available JupyterLab commands with their full reference IDs and arguments in a dedicated tab',
   autoStart: true,
-  requires: [ICommandPalette, ISettingRegistry],
+  requires: [ICommandPalette, ISettingRegistry, ITranslator],
   activate: async (
     app: JupyterFrontEnd,
     palette: ICommandPalette,
-    settingRegistry: ISettingRegistry
+    settingRegistry: ISettingRegistry,
+    translator: ITranslator | null
   ) => {
+    const trans = (translator ?? nullTranslator).load(
+      'jupyterlab_commands_extension'
+    );
+
     console.log(
       'JupyterLab extension jupyterlab_commands_extension is activated!'
     );
@@ -65,20 +73,24 @@ const plugin: JupyterFrontEndPlugin<void> = {
 
     // Register the command
     app.commands.addCommand(CommandIDs.open, {
-      label: 'Show Commands Reference',
-      caption:
-        'Display all available JupyterLab commands with their IDs and arguments',
-      execute: () => {
+      label: trans.__('Show Commands Reference'),
+      caption: trans.__(
+        'Display all available JupyterLab commands with their IDs and arguments'
+      ),
+      describedBy: () => ({}),
+      execute: async () => {
         // Create widget if it doesn't exist or was disposed
         if (!widget || widget.isDisposed) {
+          const { CommandsReferenceWidget } = await import('./widget');
           const content = new CommandsReferenceWidget(
             app.commands,
             settings,
-            settingRegistry
+            settingRegistry,
+            trans
           );
           widget = new MainAreaWidget({ content });
           widget.id = 'jp-commands-reference';
-          widget.title.label = 'Commands Reference';
+          widget.title.label = trans.__('Commands Reference');
           widget.title.icon = textEditorIcon;
           widget.title.closable = true;
 
@@ -101,14 +113,16 @@ const plugin: JupyterFrontEndPlugin<void> = {
     // Add command to palette under Help category
     palette.addItem({
       command: CommandIDs.open,
-      category: 'Help'
+      category: trans.__('Help')
     });
 
     // Download a file the contents API serves to the computer that runs
     // the browser tab.
     app.commands.addCommand(CommandIDs.download, {
-      label: 'Download File',
-      caption: 'Download a file from the server to the local computer',
+      label: trans.__('Download File'),
+      caption: trans.__(
+        'Download a file from the server to the local computer'
+      ),
       describedBy: () => ({
         args: {
           type: 'object',

package/src/relay.ts

@@ -1,5 +1,5 @@
 import type { JupyterFrontEnd } from '@jupyterlab/application';
-import { PageConfig, URLExt } from '@jupyterlab/coreutils';
+import { URLExt } from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import type { ISettingRegistry } from '@jupyterlab/settingregistry';
 import type { CommandRegistry } from '@lumino/commands';
@@ -260,7 +260,12 @@ export class RelayClient {
    * Build the URL of one relay endpoint.
    */
   private _url(endpoint: string): string {
-    return URLExt.join(PageConfig.getBaseUrl(), API_NAMESPACE, 'api', endpoint);
+    return URLExt.join(
+      this._serverSettings.baseUrl,
+      API_NAMESPACE,
+      'api',
+      endpoint
+    );
   }
 
   private _get(endpoint: string): Promise<any> {

package/src/widget.ts

@@ -1,6 +1,8 @@
 import { Widget } from '@lumino/widgets';
 import { CommandRegistry } from '@lumino/commands';
 import type { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { nullTranslator } from '@jupyterlab/translation';
+import type { TranslationBundle } from '@jupyterlab/translation';
 
 import { addAllowedCommand, getAllowedCommands } from './allowlist';
 import { collectCommands, describeCommand, ICommandInfo } from './commands';
@@ -17,16 +19,21 @@ export class CommandsReferenceWidget extends Widget {
   private _tbody!: HTMLTableSectionElement;
   private _commandsCache: ICommandInfo[] = [];
   private _argsCache: Map<string, string> = new Map();
+  private _trans: TranslationBundle;
 
   constructor(
     commands: CommandRegistry,
     settings: ISettingRegistry.ISettings | null = null,
-    registry: ISettingRegistry | null = null
+    registry: ISettingRegistry | null = null,
+    trans: TranslationBundle = nullTranslator.load(
+      'jupyterlab_commands_extension'
+    )
   ) {
     super();
     this._commands = commands;
     this._settings = settings;
     this._registry = registry;
+    this._trans = trans;
     this.addClass('jp-CommandsReferenceWidget');
 
     if (this._settings) {
@@ -68,7 +75,7 @@ export class CommandsReferenceWidget extends Widget {
     // Search input
     this._searchInput = document.createElement('input');
     this._searchInput.type = 'text';
-    this._searchInput.placeholder = 'Filter commands...';
+    this._searchInput.placeholder = this._trans.__('Filter commands...');
     this._searchInput.className =
       'jp-CommandsReferenceWidget-search jp-mod-styled';
     this._searchInput.addEventListener('input', () => {
@@ -98,11 +105,11 @@ export class CommandsReferenceWidget extends Widget {
     const thead = document.createElement('thead');
     const headerRow = document.createElement('tr');
     const headers = [
-      'Command ID',
-      'Label',
-      'Description',
-      'Arguments',
-      'Command Executor'
+      this._trans.__('Command ID'),
+      this._trans.__('Label'),
+      this._trans.__('Description'),
+      this._trans.__('Arguments'),
+      this._trans.__('Command Executor')
     ];
     for (const headerText of headers) {
       const th = document.createElement('th');
@@ -235,10 +242,10 @@ export class CommandsReferenceWidget extends Widget {
         void this._addToExecutor(cmd.id, button);
       });
       if (this._isAllowed(cmd.id)) {
-        button.textContent = 'Added';
+        button.textContent = this._trans.__('Added');
         button.disabled = true;
       } else {
-        button.textContent = 'Add to command executor';
+        button.textContent = this._trans.__('Add to command executor');
         button.disabled = !this._settings || !this._registry;
       }
       executorCell.appendChild(button);
@@ -295,10 +302,10 @@ export class CommandsReferenceWidget extends Widget {
     button.disabled = true;
     try {
       await addAllowedCommand(this._settings, this._registry, commandId);
-      button.textContent = 'Added';
+      button.textContent = this._trans.__('Added');
     } catch (error) {
       console.error('Commands Reference: cannot update allowedCommands', error);
-      button.textContent = 'Add to command executor';
+      button.textContent = this._trans.__('Add to command executor');
       button.disabled = false;
     }
   }
@@ -313,7 +320,9 @@ export class CommandsReferenceWidget extends Widget {
     for (const button of Array.from(buttons)) {
       const commandId = button.dataset.commandId || '';
       const allowed = this._isAllowed(commandId);
-      button.textContent = allowed ? 'Added' : 'Add to command executor';
+      button.textContent = allowed
+        ? this._trans.__('Added')
+        : this._trans.__('Add to command executor');
       button.disabled =
         allowed || this._settings === null || this._registry === null;
     }