@jupyter-notebook/application-extension 7.0.0-beta.3 → 7.0.0-rc.0

package/lib/index.js

@@ -1,14 +1,15 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
 import { ILabStatus, IRouter, ITreePathUpdater, JupyterFrontEnd, } from '@jupyterlab/application';
-import { DOMUtils, ICommandPalette, IToolbarWidgetRegistry, } from '@jupyterlab/apputils';
+import { DOMUtils, ICommandPalette, ISanitizer, ISplashScreen, IToolbarWidgetRegistry, } from '@jupyterlab/apputils';
 import { ConsolePanel } from '@jupyterlab/console';
 import { PageConfig, PathExt, URLExt } from '@jupyterlab/coreutils';
 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 { ITranslator } from '@jupyterlab/translation';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { NotebookApp, NotebookShell, INotebookShell, SidePanelPalette, } from '@jupyter-notebook/application';
 import { jupyterIcon } from '@jupyter-notebook/ui-components';
 import { PromiseDelegate } from '@lumino/coreutils';
@@ -22,11 +23,19 @@ const TREE_PATTERN = new RegExp('/(notebooks|edit)/(.*)');
  * A regular expression to suppress the file extension from display for .ipynb files.
  */
 const STRIP_IPYNB = /\.ipynb$/;
+/**
+ * The JupyterLab document manager plugin id.
+ */
+const JUPYTERLAB_DOCMANAGER_PLUGIN_ID = '@jupyterlab/docmanager-extension:plugin';
 /**
  * The command IDs used by the application plugin.
  */
 var CommandIDs;
 (function (CommandIDs) {
+    /**
+     * Handle local links
+     */
+    CommandIDs.handleLink = 'application:handle-local-link';
     /**
      * Toggle Top Bar visibility
      */
@@ -108,22 +117,43 @@ const opener = {
     id: '@jupyter-notebook/application-extension:opener',
     autoStart: true,
     requires: [IRouter, IDocumentManager],
-    activate: (app, router, docManager) => {
-        const { commands } = app;
+    optional: [ISettingRegistry],
+    activate: (app, router, docManager, settingRegistry) => {
+        const { commands, docRegistry } = app;
         const command = 'router:tree';
         commands.addCommand(command, {
             execute: (args) => {
-                var _a, _b;
+                var _a;
                 const parsed = args;
                 const matches = (_a = parsed.path.match(TREE_PATTERN)) !== null && _a !== void 0 ? _a : [];
                 const [, , path] = matches;
                 if (!path) {
                     return;
                 }
-                const file = decodeURIComponent(path);
-                const urlParams = new URLSearchParams(parsed.search);
-                const factory = (_b = urlParams.get('factory')) !== null && _b !== void 0 ? _b : 'default';
                 app.started.then(async () => {
+                    var _a;
+                    const file = decodeURIComponent(path);
+                    const urlParams = new URLSearchParams(parsed.search);
+                    let defaultFactory = docRegistry.defaultWidgetFactory(path).name;
+                    // Explicitely get the default viewers from the settings because
+                    // JupyterLab might not have had the time to load the settings yet (race condition)
+                    // Relevant code: https://github.com/jupyterlab/jupyterlab/blob/d56ff811f39b3c10c6d8b6eb27a94624b753eb53/packages/docmanager-extension/src/index.tsx#L265-L293
+                    if (settingRegistry) {
+                        const settings = await settingRegistry.load(JUPYTERLAB_DOCMANAGER_PLUGIN_ID);
+                        const defaultViewers = settings.get('defaultViewers').composite;
+                        // get the file types for the path
+                        const types = docRegistry.getFileTypesForPath(path);
+                        // for each file type, check if there is a default viewer and if it
+                        // is available in the docRegistry. If it is the case, use it as the
+                        // default factory
+                        types.forEach((ft) => {
+                            if (defaultViewers[ft.name] !== undefined &&
+                                docRegistry.getWidgetFactory(defaultViewers[ft.name])) {
+                                defaultFactory = defaultViewers[ft.name];
+                            }
+                        });
+                    }
+                    const factory = (_a = urlParams.get('factory')) !== null && _a !== void 0 ? _a : defaultFactory;
                     docManager.open(file, factory, undefined, {
                         ref: '_noref',
                     });
@@ -223,19 +253,122 @@ const paths = {
         return app.paths;
     },
 };
+/**
+ * A plugin providing a rendermime registry.
+ */
+const rendermime = {
+    id: '@jupyter-notebook/application-extension:rendermime',
+    autoStart: true,
+    provides: IRenderMimeRegistry,
+    description: 'Provides the render mime registry.',
+    optional: [
+        IDocumentManager,
+        ILatexTypesetter,
+        ISanitizer,
+        IMarkdownParser,
+        ITranslator,
+    ],
+    activate: (app, docManager, latexTypesetter, sanitizer, markdownParser, translator) => {
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyterlab');
+        if (docManager) {
+            app.commands.addCommand(CommandIDs.handleLink, {
+                label: trans.__('Handle Local Link'),
+                execute: (args) => {
+                    const path = args['path'];
+                    if (path === undefined || path === null) {
+                        return;
+                    }
+                    return docManager.services.contents
+                        .get(path, { content: false })
+                        .then((model) => {
+                        // Open in a new browser tab
+                        const url = PageConfig.getBaseUrl();
+                        const treeUrl = URLExt.join(url, 'tree', model.path);
+                        window.open(treeUrl, '_blank');
+                    });
+                },
+            });
+        }
+        return new RenderMimeRegistry({
+            initialFactories: standardRendererFactories,
+            linkHandler: !docManager
+                ? undefined
+                : {
+                    handleLink: (node, path, id) => {
+                        // If node has the download attribute explicitly set, use the
+                        // default browser downloading behavior.
+                        if (node.tagName === 'A' && node.hasAttribute('download')) {
+                            return;
+                        }
+                        app.commandLinker.connectNode(node, CommandIDs.handleLink, {
+                            path,
+                            id,
+                        });
+                    },
+                },
+            latexTypesetter: latexTypesetter !== null && latexTypesetter !== void 0 ? latexTypesetter : undefined,
+            markdownParser: markdownParser !== null && markdownParser !== void 0 ? markdownParser : undefined,
+            translator: translator !== null && translator !== void 0 ? translator : undefined,
+            sanitizer: sanitizer !== null && sanitizer !== void 0 ? sanitizer : undefined,
+        });
+    },
+};
 /**
  * The default Jupyter Notebook application shell.
  */
 const shell = {
     id: '@jupyter-notebook/application-extension:shell',
-    activate: (app) => {
+    autoStart: true,
+    provides: INotebookShell,
+    optional: [ISettingRegistry],
+    activate: (app, settingRegistry) => {
         if (!(app.shell instanceof NotebookShell)) {
             throw new Error(`${shell.id} did not find a NotebookShell instance.`);
         }
-        return app.shell;
+        const notebookShell = app.shell;
+        if (settingRegistry) {
+            settingRegistry
+                .load(shell.id)
+                .then((settings) => {
+                // Add a layer of customization to support app shell mode
+                const customLayout = settings.composite['layout'];
+                // Restore the layout.
+                void notebookShell.restoreLayout(customLayout);
+            })
+                .catch((reason) => {
+                console.error('Fail to load settings for the layout restorer.');
+                console.error(reason);
+            });
+        }
+        return notebookShell;
     },
+};
+/**
+ * The default splash screen provider.
+ */
+const splash = {
+    id: '@jupyter-notebook/application-extension:splash',
+    description: 'Provides an empty splash screen.',
     autoStart: true,
-    provides: INotebookShell,
+    provides: ISplashScreen,
+    activate: (app) => {
+        const { restored } = app;
+        const splash = document.createElement('div');
+        splash.style.position = 'absolute';
+        splash.style.width = '100%';
+        splash.style.height = '100%';
+        splash.style.zIndex = '10';
+        return {
+            show: (light = true) => {
+                splash.style.backgroundColor = light ? 'white' : '#111111';
+                document.body.appendChild(splash);
+                return new DisposableDelegate(async () => {
+                    await restored;
+                    document.body.removeChild(splash);
+                });
+            },
+        };
+    },
 };
 /**
  * The default JupyterLab application status provider.
@@ -739,8 +872,10 @@ const plugins = [
     opener,
     pages,
     paths,
+    rendermime,
     shell,
     sidePanelVisibility,
+    splash,
     status,
     tabTitle,
     title,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/application-extension",
-  "version": "7.0.0-beta.3",
+  "version": "7.0.0-rc.0",
   "description": "Jupyter Notebook - Application Extension",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -38,18 +38,19 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter-notebook/application": "^7.0.0-beta.3",
-    "@jupyter-notebook/ui-components": "^7.0.0-beta.3",
-    "@jupyterlab/application": "^4.0.0",
-    "@jupyterlab/apputils": "^4.0.0",
-    "@jupyterlab/codeeditor": "^4.0.0",
-    "@jupyterlab/console": "^4.0.0",
-    "@jupyterlab/coreutils": "^6.0.0",
-    "@jupyterlab/docmanager": "^4.0.0",
-    "@jupyterlab/docregistry": "^4.0.0",
-    "@jupyterlab/mainmenu": "^4.0.0",
-    "@jupyterlab/settingregistry": "^4.0.0",
-    "@jupyterlab/translation": "^4.0.0",
+    "@jupyter-notebook/application": "^7.0.0-rc.0",
+    "@jupyter-notebook/ui-components": "^7.0.0-rc.0",
+    "@jupyterlab/application": "^4.0.2",
+    "@jupyterlab/apputils": "^4.1.2",
+    "@jupyterlab/codeeditor": "^4.0.2",
+    "@jupyterlab/console": "^4.0.2",
+    "@jupyterlab/coreutils": "^6.0.2",
+    "@jupyterlab/docmanager": "^4.0.2",
+    "@jupyterlab/docregistry": "^4.0.2",
+    "@jupyterlab/mainmenu": "^4.0.2",
+    "@jupyterlab/rendermime": "^4.0.2",
+    "@jupyterlab/settingregistry": "^4.0.2",
+    "@jupyterlab/translation": "^4.0.2",
     "@lumino/coreutils": "^2.1.1",
     "@lumino/disposable": "^2.1.1",
     "@lumino/widgets": "^2.1.1"

package/schema/shell.json

@@ -0,0 +1,34 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "title": "Notebook Shell",
+  "description": "Notebook Shell layout settings.",
+  "properties": {
+    "layout": {
+      "$ref": "#/definitions/layout",
+      "type": "object",
+      "title": "Customize shell widget positioning",
+      "description": "Overrides default widget position in the application layout",
+      "default": {
+        "Markdown Preview": { "area": "right" }
+      }
+    }
+  },
+  "additionalProperties": false,
+  "type": "object",
+  "definitions": {
+    "layout": {
+      "type": "object",
+      "properties": {
+        "[\\w-]+": {
+          "type": "object",
+          "properties": {
+            "area": {
+              "enum": ["left", "right"]
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    }
+  }
+}