@jupyter-notebook/application-extension 7.0.0-alpha.8 → 7.0.0-beta.0

package/lib/index.js

@@ -1,7 +1,7 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
-import { ILabStatus, IRouter, ITreePathUpdater, JupyterFrontEnd } from '@jupyterlab/application';
-import { sessionContextDialogs, ISessionContextDialogs, DOMUtils, ICommandPalette, IToolbarWidgetRegistry } from '@jupyterlab/apputils';
+import { ILabStatus, IRouter, ITreePathUpdater, JupyterFrontEnd, } from '@jupyterlab/application';
+import { DOMUtils, ICommandPalette, IToolbarWidgetRegistry, } from '@jupyterlab/apputils';
 import { ConsolePanel } from '@jupyterlab/console';
 import { PageConfig, PathExt, URLExt } from '@jupyterlab/coreutils';
 import { IDocumentManager, renameDialog } from '@jupyterlab/docmanager';
@@ -9,12 +9,11 @@ import { DocumentWidget } from '@jupyterlab/docregistry';
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ITranslator } from '@jupyterlab/translation';
-import { NotebookApp, NotebookShell, INotebookShell } from '@jupyter-notebook/application';
+import { NotebookApp, NotebookShell, INotebookShell, SidePanelPalette, } from '@jupyter-notebook/application';
 import { jupyterIcon } from '@jupyter-notebook/ui-components';
 import { PromiseDelegate } from '@lumino/coreutils';
-import { DisposableDelegate, DisposableSet } from '@lumino/disposable';
+import { DisposableDelegate, DisposableSet, } from '@lumino/disposable';
 import { Menu, Widget } from '@lumino/widgets';
-import { SideBarPalette } from './sidebarpalette';
 /**
  * A regular expression to match path to notebooks and documents
  */
@@ -33,7 +32,7 @@ var CommandIDs;
      */
     CommandIDs.toggleTop = 'application:toggle-top';
     /**
-     * Toggle sidebar visibility
+     * Toggle side panel visibility
      */
     CommandIDs.togglePanel = 'application:toggle-panel';
     /**
@@ -70,12 +69,12 @@ const dirty = {
         }
         const trans = translator.load('notebook');
         const message = trans.__('Are you sure you want to exit Jupyter Notebook?\n\nAny unsaved changes will be lost.');
-        window.addEventListener('beforeunload', event => {
+        window.addEventListener('beforeunload', (event) => {
             if (app.status.isDirty) {
                 return (event.returnValue = message);
             }
         });
-    }
+    },
 };
 /**
  * The logo plugin.
@@ -96,11 +95,11 @@ const logo = {
             padding: '2px 2px 2px 8px',
             height: '28px',
             width: 'auto',
-            cursor: 'pointer'
+            cursor: 'pointer',
         });
         logo.id = 'jp-NotebookLogo';
         app.shell.add(logo, 'top', { rank: 0 });
-    }
+    },
 };
 /**
  * A plugin to open documents in the main area.
@@ -126,13 +125,13 @@ const opener = {
                 const factory = (_b = urlParams.get('factory')) !== null && _b !== void 0 ? _b : 'default';
                 app.started.then(async () => {
                     docManager.open(file, factory, undefined, {
-                        ref: '_noref'
+                        ref: '_noref',
                     });
                 });
-            }
+            },
         });
         router.register({ command, pattern: TREE_PATTERN });
-    }
+    },
 };
 /**
  * A plugin to customize menus
@@ -160,7 +159,7 @@ const menus = {
             default:
                 break;
         }
-    }
+    },
 };
 /**
  * A plugin to provide a spacer at rank 900 in the menu area
@@ -173,7 +172,7 @@ const menuSpacer = {
         menu.id = DOMUtils.createDomID();
         menu.addClass('jp-NotebookSpacer');
         app.shell.add(menu, 'menu', { rank: 900 });
-    }
+    },
 };
 /**
  * Add commands to open the tree and running pages.
@@ -190,20 +189,25 @@ const pages = {
             label: trans.__('Open JupyterLab'),
             execute: () => {
                 window.open(`${baseUrl}lab`);
-            }
+            },
         });
+        const page = PageConfig.getOption('notebookPage');
         app.commands.addCommand(CommandIDs.openTree, {
-            label: trans.__('Open Files'),
+            label: trans.__('File Browser'),
             execute: () => {
-                window.open(`${baseUrl}tree`);
-            }
+                if (page === 'tree') {
+                    app.commands.execute('filebrowser:activate');
+                }
+                else {
+                    window.open(`${baseUrl}tree`);
+                }
+            },
         });
         if (palette) {
-            [CommandIDs.openLab, CommandIDs.openTree].forEach(command => {
-                palette.addItem({ command, category: 'View' });
-            });
+            palette.addItem({ command: CommandIDs.openLab, category: 'View' });
+            palette.addItem({ command: CommandIDs.openTree, category: 'View' });
         }
-    }
+    },
 };
 /**
  * The default paths for a Jupyter Notebook app.
@@ -217,16 +221,7 @@ const paths = {
             throw new Error(`${paths.id} must be activated in Jupyter Notebook.`);
         }
         return app.paths;
-    }
-};
-/**
- * The default session dialogs plugin
- */
-const sessionDialogs = {
-    id: '@jupyter-notebook/application-extension:session-dialogs',
-    provides: ISessionContextDialogs,
-    autoStart: true,
-    activate: () => sessionContextDialogs
+    },
 };
 /**
  * The default Jupyter Notebook application shell.
@@ -240,7 +235,7 @@ const shell = {
         return app.shell;
     },
     autoStart: true,
-    provides: INotebookShell
+    provides: INotebookShell,
 };
 /**
  * The default JupyterLab application status provider.
@@ -254,7 +249,7 @@ const status = {
             throw new Error(`${status.id} must be activated in Jupyter Notebook.`);
         }
         return app.status;
-    }
+    },
 };
 /**
  * A plugin to display the document title in the browser tab title
@@ -288,7 +283,7 @@ const tabTitle = {
         };
         shell.currentChanged.connect(setTabTitle);
         setTabTitle();
-    }
+    },
 };
 /**
  * A plugin to display and rename the title of a file
@@ -303,7 +298,7 @@ const title = {
         const trans = translator.load('notebook');
         const node = document.createElement('div');
         if (toolbarRegistry) {
-            toolbarRegistry.addFactory('TopBar', 'widgetTitle', toolbar => {
+            toolbarRegistry.addFactory('TopBar', 'widgetTitle', (toolbar) => {
                 const widget = new Widget({ node });
                 widget.id = 'jp-title';
                 return widget;
@@ -357,9 +352,9 @@ const title = {
                     }
                     const encoded = encodeURIComponent(newPath);
                     router.navigate(`/${route}/${encoded}`, {
-                        skipRouting: true
+                        skipRouting: true,
                     });
-                }
+                },
             });
             node.onclick = async () => {
                 void commands.execute(CommandIDs.rename);
@@ -367,7 +362,7 @@ const title = {
         };
         shell.currentChanged.connect(addTitle);
         void addTitle();
-    }
+    },
 };
 /**
  * Plugin to toggle the top header visibility.
@@ -388,7 +383,7 @@ const topVisibility = {
                     void settingRegistry.set(pluginId, 'visible', top.isVisible);
                 }
             },
-            isToggled: () => top.isVisible
+            isToggled: () => top.isVisible,
         });
         let settingsOverride = false;
         if (settingRegistry) {
@@ -403,7 +398,7 @@ const topVisibility = {
             Promise.all([loadSettings, app.restored])
                 .then(([settings]) => {
                 updateSettings(settings);
-                settings.changed.connect(settings => {
+                settings.changed.connect((settings) => {
                     updateSettings(settings);
                 });
             })
@@ -428,13 +423,13 @@ const topVisibility = {
         // listen on format change (mobile and desktop) to make the view more compact
         app.formatChanged.connect(onChanged);
     },
-    autoStart: true
+    autoStart: true,
 };
 /**
- * Plugin to toggle the left or right sidebar's visibility.
+ * Plugin to toggle the left or right side panel's visibility.
  */
-const sidebarVisibility = {
-    id: '@jupyter-notebook/application-extension:sidebar',
+const sidePanelVisibility = {
+    id: '@jupyter-notebook/application-extension:sidepanel',
     requires: [INotebookShell, ITranslator],
     optional: [IMainMenu, ICommandPalette],
     autoStart: true,
@@ -443,11 +438,11 @@ const sidebarVisibility = {
         /* Arguments for togglePanel command:
          * side, left or right area
          * title, widget title to show in the menu
-         * id, widget ID to activate in the sidebar
+         * id, widget ID to activate in the side panel
          */
         app.commands.addCommand(CommandIDs.togglePanel, {
-            label: args => args['title'],
-            caption: args => {
+            label: (args) => args['title'],
+            caption: (args) => {
                 // We do not substitute the parameter into the string because the parameter is not
                 // localized (e.g., it is always 'left') even though the string is localized.
                 if (args['side'] === 'left') {
@@ -458,7 +453,7 @@ const sidebarVisibility = {
                 }
                 return trans.__('Show %1 in the sidebar', args['title']);
             },
-            execute: args => {
+            execute: (args) => {
                 var _a, _b;
                 switch (args['side']) {
                     case 'left':
@@ -491,7 +486,7 @@ const sidebarVisibility = {
                         break;
                 }
             },
-            isToggled: args => {
+            isToggled: (args) => {
                 switch (args['side']) {
                     case 'left': {
                         if (notebookShell.leftCollapsed) {
@@ -515,17 +510,17 @@ const sidebarVisibility = {
                     }
                 }
                 return false;
-            }
+            },
         });
-        const sideBarMenu = {
+        const sidePanelMenu = {
             left: null,
-            right: null
+            right: null,
         };
         /**
-         * The function which adds entries to the View menu for each widget of a sidebar.
+         * The function which adds entries to the View menu for each widget of a side panel.
          *
-         * @param area - 'left' or 'right', the area of the side bar.
-         * @param entryLabel - the name of the main entry in the View menu for that sidebar.
+         * @param area - 'left' or 'right', the area of the side panel.
+         * @param entryLabel - the name of the main entry in the View menu for that side panel.
          * @returns - The disposable menu added to the View menu or null.
          */
         const updateMenu = (area, entryLabel) => {
@@ -533,86 +528,86 @@ const sidebarVisibility = {
             if (menu === null) {
                 return null;
             }
-            // Remove the previous menu entry for this sidebar.
-            (_a = sideBarMenu[area]) === null || _a === void 0 ? void 0 : _a.dispose();
-            // Creates a new menu entry and populates it with sidebar widgets.
+            // Remove the previous menu entry for this side panel.
+            (_a = sidePanelMenu[area]) === null || _a === void 0 ? void 0 : _a.dispose();
+            // Creates a new menu entry and populates it with side panel widgets.
             const newMenu = new Menu({ commands: app.commands });
             newMenu.title.label = entryLabel;
             const widgets = notebookShell.widgets(area);
             let menuToAdd = false;
-            for (let widget of widgets) {
+            for (const widget of widgets) {
                 newMenu.addItem({
                     command: CommandIDs.togglePanel,
                     args: {
                         side: area,
                         title: `Show ${widget.title.caption}`,
-                        id: widget.id
-                    }
+                        id: widget.id,
+                    },
                 });
                 menuToAdd = true;
             }
             // If there are widgets, add the menu to the main menu entry.
             if (menuToAdd) {
-                sideBarMenu[area] = menu.viewMenu.addItem({
+                sidePanelMenu[area] = menu.viewMenu.addItem({
                     type: 'submenu',
-                    submenu: newMenu
+                    submenu: newMenu,
                 });
             }
         };
         app.restored.then(() => {
             // Create menu entries for the left and right panel.
             if (menu) {
-                const getSideBarLabel = (area) => {
+                const getSidePanelLabel = (area) => {
                     if (area === 'left') {
-                        return trans.__(`Left Sidebar`);
+                        return trans.__('Left Sidebar');
                     }
                     else {
-                        return trans.__(`Right Sidebar`);
+                        return trans.__('Right Sidebar');
                     }
                 };
                 const leftArea = notebookShell.leftHandler.area;
-                const leftLabel = getSideBarLabel(leftArea);
+                const leftLabel = getSidePanelLabel(leftArea);
                 updateMenu(leftArea, leftLabel);
                 const rightArea = notebookShell.rightHandler.area;
-                const rightLabel = getSideBarLabel(rightArea);
+                const rightLabel = getSidePanelLabel(rightArea);
                 updateMenu(rightArea, rightLabel);
-                const handleSideBarChange = (sidebar, widget) => {
-                    const label = getSideBarLabel(sidebar.area);
-                    updateMenu(sidebar.area, label);
+                const handleSidePanelChange = (sidePanel, widget) => {
+                    const label = getSidePanelLabel(sidePanel.area);
+                    updateMenu(sidePanel.area, label);
                 };
-                notebookShell.leftHandler.widgetAdded.connect(handleSideBarChange);
-                notebookShell.leftHandler.widgetRemoved.connect(handleSideBarChange);
-                notebookShell.rightHandler.widgetAdded.connect(handleSideBarChange);
-                notebookShell.rightHandler.widgetRemoved.connect(handleSideBarChange);
+                notebookShell.leftHandler.widgetAdded.connect(handleSidePanelChange);
+                notebookShell.leftHandler.widgetRemoved.connect(handleSidePanelChange);
+                notebookShell.rightHandler.widgetAdded.connect(handleSidePanelChange);
+                notebookShell.rightHandler.widgetRemoved.connect(handleSidePanelChange);
             }
             // Add palette entries for side panels.
             if (palette) {
-                const sideBarPalette = new SideBarPalette({
+                const sidePanelPalette = new SidePanelPalette({
                     commandPalette: palette,
-                    command: CommandIDs.togglePanel
+                    command: CommandIDs.togglePanel,
                 });
-                notebookShell.leftHandler.widgets.forEach(widget => {
-                    sideBarPalette.addItem(widget, notebookShell.leftHandler.area);
+                notebookShell.leftHandler.widgets.forEach((widget) => {
+                    sidePanelPalette.addItem(widget, notebookShell.leftHandler.area);
                 });
-                notebookShell.rightHandler.widgets.forEach(widget => {
-                    sideBarPalette.addItem(widget, notebookShell.rightHandler.area);
+                notebookShell.rightHandler.widgets.forEach((widget) => {
+                    sidePanelPalette.addItem(widget, notebookShell.rightHandler.area);
                 });
-                // Update menu and palette when widgets are added or removed from sidebars.
-                notebookShell.leftHandler.widgetAdded.connect((sidebar, widget) => {
-                    sideBarPalette.addItem(widget, sidebar.area);
+                // Update menu and palette when widgets are added or removed from side panels.
+                notebookShell.leftHandler.widgetAdded.connect((sidePanel, widget) => {
+                    sidePanelPalette.addItem(widget, sidePanel.area);
                 });
-                notebookShell.leftHandler.widgetRemoved.connect((sidebar, widget) => {
-                    sideBarPalette.removeItem(widget, sidebar.area);
+                notebookShell.leftHandler.widgetRemoved.connect((sidePanel, widget) => {
+                    sidePanelPalette.removeItem(widget, sidePanel.area);
                 });
-                notebookShell.rightHandler.widgetAdded.connect((sidebar, widget) => {
-                    sideBarPalette.addItem(widget, sidebar.area);
+                notebookShell.rightHandler.widgetAdded.connect((sidePanel, widget) => {
+                    sidePanelPalette.addItem(widget, sidePanel.area);
                 });
-                notebookShell.rightHandler.widgetRemoved.connect((sidebar, widget) => {
-                    sideBarPalette.removeItem(widget, sidebar.area);
+                notebookShell.rightHandler.widgetRemoved.connect((sidePanel, widget) => {
+                    sidePanelPalette.removeItem(widget, sidePanel.area);
                 });
             }
         });
-    }
+    },
 };
 /**
  * The default tree route resolver plugin.
@@ -640,7 +635,7 @@ const tree = {
                 // Clean up artifacts immediately upon routing.
                 set.dispose();
                 delegate.resolve({ browser, file: PageConfig.getOption('treePath') });
-            })
+            }),
         }));
         set.add(router.register({ command: CommandIDs.resolveTree, pattern: treePattern }));
         // If a route is handled by the router without the tree command being
@@ -657,7 +652,7 @@ const tree = {
             router.routed.disconnect(listener);
         }));
         return { paths: delegate.promise };
-    }
+    },
 };
 const treePathUpdater = {
     id: '@jupyter-notebook/application-extension:tree-updater',
@@ -674,7 +669,15 @@ const treePathUpdater = {
         }
         return updateTreePath;
     },
-    autoStart: true
+    autoStart: true,
+};
+const translator = {
+    id: '@jupyter-notebook/application-extension:translator',
+    requires: [INotebookShell, ITranslator],
+    autoStart: true,
+    activate: (app, notebookShell, translator) => {
+        notebookShell.translator = translator;
+    },
 };
 /**
  * Zen mode plugin
@@ -710,7 +713,7 @@ const zen = {
                     document.exitFullscreen();
                     toggleOff();
                 }
-            }
+            },
         });
         document.addEventListener('fullscreenchange', () => {
             if (!document.fullscreenElement) {
@@ -720,7 +723,7 @@ const zen = {
         if (palette) {
             palette.addItem({ command: CommandIDs.toggleZen, category: 'Mode' });
         }
-    }
+    },
 };
 /**
  * Export the plugins as default.
@@ -733,15 +736,15 @@ const plugins = [
     opener,
     pages,
     paths,
-    sessionDialogs,
     shell,
-    sidebarVisibility,
+    sidePanelVisibility,
     status,
     tabTitle,
     title,
     topVisibility,
     tree,
     treePathUpdater,
-    zen
+    translator,
+    zen,
 ];
 export default plugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/application-extension",
-  "version": "7.0.0-alpha.8",
+  "version": "7.0.0-beta.0",
   "description": "Jupyter Notebook - Application Extension",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -35,30 +35,29 @@
     "build:prod": "tsc -b",
     "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
     "docs": "typedoc src",
-    "prepublishOnly": "npm run build",
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter-notebook/application": "^7.0.0-alpha.8",
-    "@jupyter-notebook/ui-components": "^7.0.0-alpha.8",
-    "@jupyterlab/application": "^4.0.0-alpha.15",
-    "@jupyterlab/apputils": "^4.0.0-alpha.15",
-    "@jupyterlab/celltags": "^4.0.0-alpha.15",
-    "@jupyterlab/codeeditor": "^4.0.0-alpha.15",
-    "@jupyterlab/console": "^4.0.0-alpha.15",
-    "@jupyterlab/coreutils": "^6.0.0-alpha.15",
-    "@jupyterlab/docmanager": "^4.0.0-alpha.15",
-    "@jupyterlab/docregistry": "^4.0.0-alpha.15",
-    "@jupyterlab/mainmenu": "^4.0.0-alpha.15",
-    "@jupyterlab/settingregistry": "^4.0.0-alpha.15",
-    "@jupyterlab/translation": "^4.0.0-alpha.15",
-    "@lumino/coreutils": "^2.0.0-alpha.6",
-    "@lumino/disposable": "^2.0.0-alpha.6",
-    "@lumino/widgets": "^2.0.0-alpha.6"
+    "@jupyter-notebook/application": "^7.0.0-beta.0",
+    "@jupyter-notebook/ui-components": "^7.0.0-beta.0",
+    "@jupyterlab/application": "^4.0.0-beta.0",
+    "@jupyterlab/apputils": "^4.0.0-beta.0",
+    "@jupyterlab/celltags": "^4.0.0-alpha.20",
+    "@jupyterlab/codeeditor": "^4.0.0-beta.0",
+    "@jupyterlab/console": "^4.0.0-beta.0",
+    "@jupyterlab/coreutils": "^6.0.0-beta.0",
+    "@jupyterlab/docmanager": "^4.0.0-beta.0",
+    "@jupyterlab/docregistry": "^4.0.0-beta.0",
+    "@jupyterlab/mainmenu": "^4.0.0-beta.0",
+    "@jupyterlab/settingregistry": "^4.0.0-beta.0",
+    "@jupyterlab/translation": "^4.0.0-beta.0",
+    "@lumino/coreutils": "^2.0.0",
+    "@lumino/disposable": "^2.0.0",
+    "@lumino/widgets": "^2.0.1"
   },
   "devDependencies": {
     "rimraf": "^3.0.2",
-    "typescript": "~4.7.3"
+    "typescript": "~5.0.2"
   },
   "publishConfig": {
     "access": "public"

package/style/base.css

@@ -23,3 +23,13 @@
   text-align: center;
   margin-top: 8px;
 }
+
+.jp-MimeDocument .jp-RenderedJSON {
+  background: var(--jp-layout-color0);
+}
+
+/* Hide the stub toolbar that appears above terminals and documents */
+
+.jp-MainAreaWidget > .jp-Toolbar-micro {
+  display: none;
+}

package/lib/sidebarpalette.d.ts

@@ -1,61 +0,0 @@
-import { ICommandPalette } from '@jupyterlab/apputils';
-import { IDisposable } from '@lumino/disposable';
-import { Widget } from '@lumino/widgets';
-/**
- * A class to manages the palette entries associated to the side bar.
- */
-export declare class SideBarPalette {
-    /**
-     * Construct a new side bar palette.
-     */
-    constructor(options: SideBarPaletteOption);
-    /**
-     * Get a command palette item from the widget id and the area.
-     */
-    getItem(widget: Readonly<Widget>, area: 'left' | 'right'): SideBarPaletteItem | null;
-    /**
-     * Add an item to the command palette.
-     */
-    addItem(widget: Readonly<Widget>, area: 'left' | 'right'): void;
-    /**
-     * Remove an item from the command palette.
-     */
-    removeItem(widget: Readonly<Widget>, area: 'left' | 'right'): void;
-    _command: string;
-    _commandPalette: ICommandPalette;
-    _items: SideBarPaletteItem[];
-}
-declare type SideBarPaletteItem = {
-    /**
-     * The ID of the widget associated to the command palette.
-     */
-    widgetId: string;
-    /**
-     * The area of the panel associated to the command palette.
-     */
-    area: 'left' | 'right';
-    /**
-     * The disposable object to remove the item from command palette.
-     */
-    disposable: IDisposable;
-};
-/**
- * An interface for the options to include in SideBarPalette constructor.
- */
-declare type SideBarPaletteOption = {
-    /**
-     * The commands palette.
-     */
-    commandPalette: ICommandPalette;
-    /**
-     * The command to call from each sidebar menu entry.
-     *
-     * ### Notes
-     * That command required 3 args :
-     *      side: 'left' | 'right', the area to toggle
-     *      title: string, label of the command
-     *      id: string, id of the widget to activate
-     */
-    command: string;
-};
-export {};

package/lib/sidebarpalette.js

@@ -1,61 +0,0 @@
-/**
- * A class to manages the palette entries associated to the side bar.
- */
-export class SideBarPalette {
-    /**
-     * Construct a new side bar palette.
-     */
-    constructor(options) {
-        this._items = [];
-        this._commandPalette = options.commandPalette;
-        this._command = options.command;
-    }
-    /**
-     * Get a command palette item from the widget id and the area.
-     */
-    getItem(widget, area) {
-        const itemList = this._items;
-        for (let i = 0; i < itemList.length; i++) {
-            const item = itemList[i];
-            if (item.widgetId == widget.id && item.area == area) {
-                return item;
-            }
-        }
-        return null;
-    }
-    /**
-     * Add an item to the command palette.
-     */
-    addItem(widget, area) {
-        // Check if the item does not already exist.
-        if (this.getItem(widget, area)) {
-            return;
-        }
-        // Add a new item in command palette.
-        const disposableDelegate = this._commandPalette.addItem({
-            command: this._command,
-            category: 'View',
-            args: {
-                side: area,
-                title: `Show ${widget.title.caption}`,
-                id: widget.id
-            }
-        });
-        // Keep the disposableDelegate objet to be able to dispose of the item if the widget
-        // is remove from the side bar.
-        this._items.push({
-            widgetId: widget.id,
-            area: area,
-            disposable: disposableDelegate
-        });
-    }
-    /**
-     * Remove an item from the command palette.
-     */
-    removeItem(widget, area) {
-        const item = this.getItem(widget, area);
-        if (item) {
-            item.disposable.dispose();
-        }
-    }
-}