@jupyter-notebook/application-extension 7.7.0-alpha.0 → 7.7.0-alpha.2

package/lib/index.js

@@ -8,10 +8,11 @@ import { IDocumentManager, renameDialog } from '@jupyterlab/docmanager';
 import { DocumentWidget } from '@jupyterlab/docregistry';
 import { IMainMenu } from '@jupyterlab/mainmenu';
 import { ILatexTypesetter, IMarkdownParser, IRenderMimeRegistry, RenderMimeRegistry, standardRendererFactories, } from '@jupyterlab/rendermime';
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { ISettingConnector, ISettingRegistry, } from '@jupyterlab/settingregistry';
 import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { NotebookApp, NotebookShell, INotebookShell, SidePanelPalette, INotebookPathOpener, defaultNotebookPathOpener, } from '@jupyter-notebook/application';
 import { jupyterIcon } from '@jupyter-notebook/ui-components';
+import { SettingConnector } from './settingconnector';
 import { PromiseDelegate } from '@lumino/coreutils';
 import { DisposableDelegate, DisposableSet, } from '@lumino/disposable';
 import { Menu, Widget } from '@lumino/widgets';
@@ -113,7 +114,7 @@ const logo = {
     description: 'The logo plugin.',
     autoStart: true,
     activate: (app) => {
-        const baseUrl = PageConfig.getBaseUrl();
+        const baseUrl = app.serviceManager.serverSettings.baseUrl;
         const node = document.createElement('a');
         node.href = `${baseUrl}tree`;
         node.target = '_blank';
@@ -177,9 +178,31 @@ const opener = {
                         });
                     }
                     const factory = (_a = urlParams.get('factory')) !== null && _a !== void 0 ? _a : defaultFactory;
-                    docManager.open(file, factory, undefined, {
+                    const kernelPreference = urlParams.get('kernel') === 'none'
+                        ? { shouldStart: false, shouldReuse: false }
+                        : undefined;
+                    const widget = docManager.openOrReveal(file, factory, undefined, {
                         ref: '_noref',
-                    });
+                    }, kernelPreference);
+                    if (kernelPreference && widget) {
+                        const { sessionContext } = widget.context;
+                        /**
+                         * `kernel=none` only describes how to open the notebook. Drop it
+                         * as soon as a kernel runs, so a reload reconnects to that session.
+                         */
+                        const clearNoKernelQuery = () => {
+                            var _a;
+                            if (!((_a = sessionContext.session) === null || _a === void 0 ? void 0 : _a.kernel)) {
+                                return;
+                            }
+                            const url = new URL(window.location.href);
+                            url.searchParams.delete('kernel');
+                            window.history.replaceState(window.history.state, '', url.toString());
+                            sessionContext.kernelChanged.disconnect(clearNoKernelQuery);
+                        };
+                        sessionContext.kernelChanged.connect(clearNoKernelQuery);
+                        clearNoKernelQuery();
+                    }
                 });
             },
             describedBy: {
@@ -256,7 +279,7 @@ const pages = {
     optional: [ICommandPalette],
     activate: (app, translator, palette) => {
         const trans = translator.load('notebook');
-        const baseUrl = PageConfig.getBaseUrl();
+        const baseUrl = app.serviceManager.serverSettings.baseUrl;
         app.commands.addCommand(CommandIDs.openLab, {
             label: trans.__('Open JupyterLab'),
             execute: () => {
@@ -274,7 +297,7 @@ const pages = {
             label: trans.__('File Browser'),
             execute: () => {
                 if (page === 'tree') {
-                    app.commands.execute('filebrowser:activate');
+                    app.commands.execute('filebrowser:open-directory');
                 }
                 else {
                     window.open(URLExt.join(baseUrl, 'tree'));
@@ -350,7 +373,7 @@ const rendermime = {
                     return docManager.services.contents
                         .get(path, { content: false })
                         .then((model) => {
-                        const baseUrl = PageConfig.getBaseUrl();
+                        const baseUrl = app.serviceManager.serverSettings.baseUrl;
                         opener.open({
                             prefix: URLExt.join(baseUrl, 'tree'),
                             path: model.path,
@@ -714,7 +737,7 @@ const sidePanelVisibility = {
          * id, widget ID to activate in the side panel
          */
         app.commands.addCommand(CommandIDs.togglePanel, {
-            label: (args) => args['title'],
+            label: (args) => trans.__('Show %1', 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.
@@ -795,7 +818,7 @@ const sidePanelVisibility = {
                         },
                         title: {
                             type: 'string',
-                            description: 'The title shown for the side panel entry.',
+                            description: 'The title of the side panel widget.',
                         },
                         id: {
                             type: 'string',
@@ -815,38 +838,38 @@ const sidePanelVisibility = {
          *
          * @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) => {
             var _a;
             if (menu === null) {
-                return null;
+                return;
             }
             // Remove the previous menu entry for this side panel.
             (_a = sidePanelMenu[area]) === null || _a === void 0 ? void 0 : _a.dispose();
+            sidePanelMenu[area] = null;
+            // Nothing to add to the View menu if the side panel has no widget.
+            const widgets = Array.from(notebookShell.widgets(area));
+            if (widgets.length === 0) {
+                return;
+            }
             // 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 (const widget of widgets) {
                 newMenu.addItem({
                     command: CommandIDs.togglePanel,
                     args: {
                         side: area,
-                        title: `Show ${widget.title.caption}`,
+                        title: widget.title.caption,
                         id: widget.id,
                     },
                 });
-                menuToAdd = true;
-            }
-            // If there are widgets, add the menu to the main menu entry.
-            if (menuToAdd) {
-                sidePanelMenu[area] = menu.viewMenu.addItem({
-                    type: 'submenu',
-                    submenu: newMenu,
-                });
             }
+            // Add the menu to the main menu entry.
+            sidePanelMenu[area] = menu.viewMenu.addItem({
+                type: 'submenu',
+                submenu: newMenu,
+            });
         };
         app.restored.then(() => {
             // Create menu entries for the left and right panel.
@@ -1058,6 +1081,21 @@ const zen = {
         }
     },
 };
+/**
+ * A plugin providing a custom setting connector to override the default
+ * values of some of the JupyterLab plugin settings, for example to open
+ * the help (pager payloads) in the down area by default, like in the
+ * Classic Notebook.
+ */
+const settingsConnector = {
+    id: '@jupyter-notebook/application-extension:settings-connector',
+    description: 'Provides a custom setting connector overriding some default setting values.',
+    autoStart: true,
+    provides: ISettingConnector,
+    activate: (app) => {
+        return new SettingConnector(app.serviceManager.settings);
+    },
+};
 /**
  * Export the plugins as default.
  */
@@ -1072,6 +1110,7 @@ const plugins = [
     pathOpener,
     paths,
     rendermime,
+    settingsConnector,
     shell,
     sidePanelVisibility,
     shortcuts,

package/lib/settingconnector.d.ts

@@ -0,0 +1,22 @@
+import { ISettingRegistry, SettingConnector as BaseSettingConnector } from '@jupyterlab/settingregistry';
+/**
+ * A data connector for fetching settings.
+ *
+ * #### Notes
+ * This connector extends the default JupyterLab setting connector with
+ * Jupyter Notebook-specific overrides.
+ */
+export declare class SettingConnector extends BaseSettingConnector {
+    /**
+     * Fetch settings for a plugin.
+     * @param id - The plugin ID
+     */
+    fetch(id: string): Promise<ISettingRegistry.IPlugin | undefined>;
+    list(query: 'ids'): Promise<{
+        ids: string[];
+    }>;
+    list(query: 'active' | 'all'): Promise<{
+        ids: string[];
+        values: ISettingRegistry.IPlugin[];
+    }>;
+}

package/lib/settingconnector.js

@@ -0,0 +1,92 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { PageConfig } from '@jupyterlab/coreutils';
+import { SettingConnector as BaseSettingConnector, } from '@jupyterlab/settingregistry';
+/**
+ * The default setting values overridden in Jupyter Notebook, mapping
+ * a plugin identifier to the overridden properties.
+ */
+const SETTING_OVERRIDES = {
+    // Use a different set of file browser defaults than JupyterLab.
+    '@jupyterlab/filebrowser-extension:browser': {
+        showFileCheckboxes: true,
+        showFileSizeColumn: true,
+        singleClickNavigation: true,
+        sortNotebooksFirst: true,
+    },
+    // Open the help (pager payloads) in the down area by default,
+    // like in the Classic Notebook.
+    '@jupyterlab/notebook-extension:tracker': {
+        helpInBottomPanel: true,
+    },
+};
+const FILE_EDITOR_PLUGIN_ID = '@jupyterlab/fileeditor-extension:plugin';
+const SYNTAX_HIGHLIGHTING_SUBMENU_ID = 'jp-mainmenu-view-codemirror-language';
+/**
+ * A data connector for fetching settings.
+ *
+ * #### Notes
+ * This connector extends the default JupyterLab setting connector with
+ * Jupyter Notebook-specific overrides.
+ */
+export class SettingConnector extends BaseSettingConnector {
+    /**
+     * Fetch settings for a plugin.
+     * @param id - The plugin ID
+     */
+    async fetch(id) {
+        const plugin = await super.fetch(id);
+        return plugin && Private.applyOverrides(plugin);
+    }
+    async list(query = 'all') {
+        if (query === 'ids') {
+            return super.list(query);
+        }
+        const { ids, values } = await super.list(query);
+        return { ids, values: values.map(Private.applyOverrides) };
+    }
+}
+/**
+ * A namespace for private module data.
+ */
+var Private;
+(function (Private) {
+    function applyOverrides(plugin) {
+        return hideSyntaxHighlightingMenu(overrideDefaults(plugin));
+    }
+    Private.applyOverrides = applyOverrides;
+    /**
+     * Override the default values of the plugin settings listed
+     * in `SETTING_OVERRIDES`.
+     */
+    function overrideDefaults(plugin) {
+        const overrides = SETTING_OVERRIDES[plugin.id];
+        const properties = plugin.schema.properties;
+        if (!overrides || !properties) {
+            return plugin;
+        }
+        for (const [property, value] of Object.entries(overrides)) {
+            if (property in properties) {
+                properties[property].default = value;
+            }
+        }
+        return plugin;
+    }
+    function hideSyntaxHighlightingMenu(plugin) {
+        var _a, _b, _c, _d;
+        const page = PageConfig.getOption('notebookPage');
+        if (plugin.id !== FILE_EDITOR_PLUGIN_ID || page === 'edit') {
+            return plugin;
+        }
+        const menus = (_b = (_a = plugin.schema['jupyter.lab.menus']) === null || _a === void 0 ? void 0 : _a.main) !== null && _b !== void 0 ? _b : [];
+        for (const menu of menus) {
+            for (const item of (_c = menu.items) !== null && _c !== void 0 ? _c : []) {
+                if (item.type === 'submenu' &&
+                    ((_d = item.submenu) === null || _d === void 0 ? void 0 : _d.id) === SYNTAX_HIGHLIGHTING_SUBMENU_ID) {
+                    item.disabled = true;
+                }
+            }
+        }
+        return plugin;
+    }
+})(Private || (Private = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/application-extension",
-  "version": "7.7.0-alpha.0",
+  "version": "7.7.0-alpha.2",
   "description": "Jupyter Notebook - Application Extension",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -38,19 +38,19 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter-notebook/application": "^7.7.0-alpha.0",
-    "@jupyter-notebook/ui-components": "^7.7.0-alpha.0",
-    "@jupyterlab/application": "~4.7.0-alpha.0",
-    "@jupyterlab/apputils": "~4.8.0-alpha.0",
-    "@jupyterlab/codeeditor": "~4.7.0-alpha.0",
-    "@jupyterlab/console": "~4.7.0-alpha.0",
-    "@jupyterlab/coreutils": "~6.7.0-alpha.0",
-    "@jupyterlab/docmanager": "~4.7.0-alpha.0",
-    "@jupyterlab/docregistry": "~4.7.0-alpha.0",
-    "@jupyterlab/mainmenu": "~4.7.0-alpha.0",
-    "@jupyterlab/rendermime": "~4.7.0-alpha.0",
-    "@jupyterlab/settingregistry": "~4.7.0-alpha.0",
-    "@jupyterlab/translation": "~4.7.0-alpha.0",
+    "@jupyter-notebook/application": "^7.7.0-alpha.2",
+    "@jupyter-notebook/ui-components": "^7.7.0-alpha.2",
+    "@jupyterlab/application": "~4.7.0-alpha.2",
+    "@jupyterlab/apputils": "~4.8.0-alpha.2",
+    "@jupyterlab/codeeditor": "~4.7.0-alpha.2",
+    "@jupyterlab/console": "~4.7.0-alpha.2",
+    "@jupyterlab/coreutils": "~6.7.0-alpha.2",
+    "@jupyterlab/docmanager": "~4.7.0-alpha.2",
+    "@jupyterlab/docregistry": "~4.7.0-alpha.2",
+    "@jupyterlab/mainmenu": "~4.7.0-alpha.2",
+    "@jupyterlab/rendermime": "~4.7.0-alpha.2",
+    "@jupyterlab/settingregistry": "~4.7.0-alpha.2",
+    "@jupyterlab/translation": "~4.7.0-alpha.2",
     "@lumino/coreutils": "^2.2.2",
     "@lumino/disposable": "^2.1.5",
     "@lumino/widgets": "^2.7.2"

package/schema/shell.json

@@ -20,20 +20,34 @@
   "definitions": {
     "layout": {
       "type": "object",
-      "properties": {
+      "patternProperties": {
         "[\\w-]+": {
           "type": "object",
           "properties": {
             "area": {
+              "type": "string",
               "oneOf": [
+                { "const": "main", "title": "Main" },
+                { "const": "top", "title": "Top" },
+                { "const": "menu", "title": "Menu" },
                 { "const": "left", "title": "Left" },
-                { "const": "right", "title": "Right" }
+                { "const": "right", "title": "Right" },
+                { "const": "down", "title": "Down" }
               ]
+            },
+            "options": {
+              "$ref": "#/definitions/options"
             }
           },
           "additionalProperties": false
         }
       }
+    },
+    "options": {
+      "type": "object",
+      "properties": {
+        "rank": { "type": "number", "minimum": 0 }
+      }
     }
   }
 }