@jupyter-notebook/application 7.0.0-alpha.1

package/lib/app.d.ts

@@ -0,0 +1,83 @@
+import { JupyterFrontEnd, JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { LabStatus } from '@jupyterlab/application/lib/status';
+import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
+import { INotebookShell } from './shell';
+/**
+ * App is the main application class. It is instantiated once and shared.
+ */
+export declare class NotebookApp extends JupyterFrontEnd<INotebookShell> {
+    /**
+     * Construct a new NotebookApp object.
+     *
+     * @param options The instantiation options for an application.
+     */
+    constructor(options?: NotebookApp.IOptions);
+    /**
+     * The name of the application.
+     */
+    readonly name = "Jupyter Notebook";
+    /**
+     * A namespace/prefix plugins may use to denote their provenance.
+     */
+    readonly namespace = "Jupyter Notebook";
+    /**
+     * The application busy and dirty status signals and flags.
+     */
+    readonly status: LabStatus;
+    /**
+     * The version of the application.
+     */
+    readonly version: string;
+    /**
+     * The JupyterLab application paths dictionary.
+     */
+    get paths(): JupyterFrontEnd.IPaths;
+    /**
+     * Handle the DOM events for the application.
+     *
+     * @param event - The DOM event sent to the application.
+     */
+    handleEvent(event: Event): void;
+    /**
+     * Register plugins from a plugin module.
+     *
+     * @param mod - The plugin module to register.
+     */
+    registerPluginModule(mod: NotebookApp.IPluginModule): void;
+    /**
+     * Register the plugins from multiple plugin modules.
+     *
+     * @param mods - The plugin modules to register.
+     */
+    registerPluginModules(mods: NotebookApp.IPluginModule[]): void;
+    private _formatter;
+}
+/**
+ * A namespace for App statics.
+ */
+export declare namespace NotebookApp {
+    /**
+     * The instantiation options for an App application.
+     */
+    interface IOptions extends JupyterFrontEnd.IOptions<INotebookShell>, Partial<IInfo> {
+    }
+    /**
+     * The information about a Jupyter Notebook application.
+     */
+    interface IInfo {
+        /**
+         * The mime renderer extensions.
+         */
+        readonly mimeExtensions: IRenderMime.IExtensionModule[];
+    }
+    /**
+     * The interface for a module that exports a plugin or plugins as
+     * the default value.
+     */
+    interface IPluginModule {
+        /**
+         * The default export.
+         */
+        default: JupyterFrontEndPlugin<any> | JupyterFrontEndPlugin<any>[];
+    }
+}

package/lib/app.js

@@ -0,0 +1,141 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { createRendermimePlugins } from '@jupyterlab/application/lib/mimerenderers';
+import { LabStatus } from '@jupyterlab/application/lib/status';
+import { PageConfig } from '@jupyterlab/coreutils';
+import { Throttler } from '@lumino/polling';
+import { NotebookShell } from './shell';
+/**
+ * App is the main application class. It is instantiated once and shared.
+ */
+export class NotebookApp extends JupyterFrontEnd {
+    /**
+     * Construct a new NotebookApp object.
+     *
+     * @param options The instantiation options for an application.
+     */
+    constructor(options = { shell: new NotebookShell() }) {
+        var _a, _b;
+        super(Object.assign(Object.assign({}, options), { shell: (_a = options.shell) !== null && _a !== void 0 ? _a : new NotebookShell() }));
+        /**
+         * The name of the application.
+         */
+        this.name = 'Jupyter Notebook';
+        /**
+         * A namespace/prefix plugins may use to denote their provenance.
+         */
+        this.namespace = this.name;
+        /**
+         * The application busy and dirty status signals and flags.
+         */
+        this.status = new LabStatus(this);
+        /**
+         * The version of the application.
+         */
+        this.version = (_b = PageConfig.getOption('appVersion')) !== null && _b !== void 0 ? _b : 'unknown';
+        this._formatter = new Throttler(() => {
+            Private.setFormat(this);
+        }, 250);
+        if (options.mimeExtensions) {
+            for (const plugin of createRendermimePlugins(options.mimeExtensions)) {
+                this.registerPlugin(plugin);
+            }
+        }
+        this.restored.then(() => this._formatter.invoke());
+    }
+    /**
+     * The JupyterLab application paths dictionary.
+     */
+    get paths() {
+        return {
+            urls: {
+                base: PageConfig.getOption('baseUrl'),
+                notFound: PageConfig.getOption('notFoundUrl'),
+                app: PageConfig.getOption('appUrl'),
+                static: PageConfig.getOption('staticUrl'),
+                settings: PageConfig.getOption('settingsUrl'),
+                themes: PageConfig.getOption('themesUrl'),
+                doc: PageConfig.getOption('docUrl'),
+                translations: PageConfig.getOption('translationsApiUrl'),
+                hubHost: PageConfig.getOption('hubHost') || undefined,
+                hubPrefix: PageConfig.getOption('hubPrefix') || undefined,
+                hubUser: PageConfig.getOption('hubUser') || undefined,
+                hubServerName: PageConfig.getOption('hubServerName') || undefined
+            },
+            directories: {
+                appSettings: PageConfig.getOption('appSettingsDir'),
+                schemas: PageConfig.getOption('schemasDir'),
+                static: PageConfig.getOption('staticDir'),
+                templates: PageConfig.getOption('templatesDir'),
+                themes: PageConfig.getOption('themesDir'),
+                userSettings: PageConfig.getOption('userSettingsDir'),
+                serverRoot: PageConfig.getOption('serverRoot'),
+                workspaces: PageConfig.getOption('workspacesDir')
+            }
+        };
+    }
+    /**
+     * Handle the DOM events for the application.
+     *
+     * @param event - The DOM event sent to the application.
+     */
+    handleEvent(event) {
+        super.handleEvent(event);
+        if (event.type === 'resize') {
+            void this._formatter.invoke();
+        }
+    }
+    /**
+     * Register plugins from a plugin module.
+     *
+     * @param mod - The plugin module to register.
+     */
+    registerPluginModule(mod) {
+        let data = mod.default;
+        // Handle commonjs exports.
+        if (!Object.prototype.hasOwnProperty.call(mod, '__esModule')) {
+            data = mod;
+        }
+        if (!Array.isArray(data)) {
+            data = [data];
+        }
+        data.forEach(item => {
+            try {
+                this.registerPlugin(item);
+            }
+            catch (error) {
+                console.error(error);
+            }
+        });
+    }
+    /**
+     * Register the plugins from multiple plugin modules.
+     *
+     * @param mods - The plugin modules to register.
+     */
+    registerPluginModules(mods) {
+        mods.forEach(mod => {
+            this.registerPluginModule(mod);
+        });
+    }
+}
+/**
+ * A namespace for module-private functionality.
+ */
+var Private;
+(function (Private) {
+    /**
+     * Media query for mobile devices.
+     */
+    const MOBILE_QUERY = 'only screen and (max-width: 760px)';
+    /**
+     * Sets the `format` of a Jupyter front-end application.
+     *
+     * @param app The front-end application whose format is set.
+     */
+    function setFormat(app) {
+        app.format = window.matchMedia(MOBILE_QUERY).matches ? 'mobile' : 'desktop';
+    }
+    Private.setFormat = setFormat;
+})(Private || (Private = {}));

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './app';
+export * from './shell';

package/lib/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export * from './app';
+export * from './shell';

package/lib/shell.d.ts

@@ -0,0 +1,83 @@
+import { JupyterFrontEnd } from '@jupyterlab/application';
+import { DocumentRegistry } from '@jupyterlab/docregistry';
+import { IIterator } from '@lumino/algorithm';
+import { Token } from '@lumino/coreutils';
+import { ISignal } from '@lumino/signaling';
+import { Widget } from '@lumino/widgets';
+/**
+ * The Jupyter Notebook application shell token.
+ */
+export declare const INotebookShell: Token<INotebookShell>;
+/**
+ * The Jupyter Notebook application shell interface.
+ */
+export interface INotebookShell extends NotebookShell {
+}
+/**
+ * The application shell.
+ */
+export declare class NotebookShell extends Widget implements JupyterFrontEnd.IShell {
+    constructor();
+    /**
+     * A signal emitted when the current widget changes.
+     */
+    get currentChanged(): ISignal<NotebookShell, void>;
+    /**
+     * The current widget in the shell's main area.
+     */
+    get currentWidget(): Widget | null;
+    /**
+     * Get the top area wrapper panel
+     */
+    get top(): Widget;
+    /**
+     * Get the menu area wrapper panel
+     */
+    get menu(): Widget;
+    /**
+     * Activate a widget in its area.
+     */
+    activateById(id: string): void;
+    /**
+     * Add a widget to the application shell.
+     *
+     * @param widget - The widget being added.
+     *
+     * @param area - Optional region in the shell into which the widget should
+     * be added.
+     *
+     * @param options - Optional open options.
+     *
+     */
+    add(widget: Widget, area?: Shell.Area, options?: DocumentRegistry.IOpenOptions): void;
+    /**
+     * Collapse the top area and the spacer to make the view more compact.
+     */
+    collapseTop(): void;
+    /**
+     * Expand the top area to show the header and the spacer.
+     */
+    expandTop(): void;
+    /**
+     * Return the list of widgets for the given area.
+     *
+     * @param area The area
+     */
+    widgets(area: Shell.Area): IIterator<Widget>;
+    private _topWrapper;
+    private _topHandler;
+    private _menuWrapper;
+    private _menuHandler;
+    private _spacer;
+    private _main;
+    private _currentChanged;
+}
+/**
+ * A namespace for Shell statics
+ */
+export declare namespace Shell {
+    /**
+     * The areas of the application shell where widgets can reside.
+     */
+    type Area = 'main' | 'top' | 'menu';
+}

package/lib/shell.js

@@ -0,0 +1,215 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { ArrayExt, find, iter } from '@lumino/algorithm';
+import { Token } from '@lumino/coreutils';
+import { MessageLoop } from '@lumino/messaging';
+import { Signal } from '@lumino/signaling';
+import { Panel, Widget, BoxLayout } from '@lumino/widgets';
+/**
+ * The Jupyter Notebook application shell token.
+ */
+export const INotebookShell = new Token('@jupyter-notebook/application:INotebookShell');
+/**
+ * The default rank for ranked panels.
+ */
+const DEFAULT_RANK = 900;
+/**
+ * The application shell.
+ */
+export class NotebookShell extends Widget {
+    constructor() {
+        super();
+        this._currentChanged = new Signal(this);
+        this.id = 'main';
+        const rootLayout = new BoxLayout();
+        this._topHandler = new Private.PanelHandler();
+        this._menuHandler = new Private.PanelHandler();
+        this._main = new Panel();
+        this._topHandler.panel.id = 'top-panel';
+        this._menuHandler.panel.id = 'menu-panel';
+        this._main.id = 'main-panel';
+        // create wrappers around the top and menu areas
+        const topWrapper = (this._topWrapper = new Panel());
+        topWrapper.id = 'top-panel-wrapper';
+        topWrapper.addWidget(this._topHandler.panel);
+        const menuWrapper = (this._menuWrapper = new Panel());
+        menuWrapper.id = 'menu-panel-wrapper';
+        menuWrapper.addWidget(this._menuHandler.panel);
+        BoxLayout.setStretch(topWrapper, 0);
+        BoxLayout.setStretch(menuWrapper, 0);
+        BoxLayout.setStretch(this._main, 1);
+        this._spacer = new Widget();
+        this._spacer.id = 'spacer-widget';
+        rootLayout.spacing = 0;
+        rootLayout.addWidget(topWrapper);
+        rootLayout.addWidget(menuWrapper);
+        rootLayout.addWidget(this._spacer);
+        rootLayout.addWidget(this._main);
+        this.layout = rootLayout;
+    }
+    /**
+     * A signal emitted when the current widget changes.
+     */
+    get currentChanged() {
+        return this._currentChanged;
+    }
+    /**
+     * The current widget in the shell's main area.
+     */
+    get currentWidget() {
+        var _a;
+        return (_a = this._main.widgets[0]) !== null && _a !== void 0 ? _a : null;
+    }
+    /**
+     * Get the top area wrapper panel
+     */
+    get top() {
+        return this._topWrapper;
+    }
+    /**
+     * Get the menu area wrapper panel
+     */
+    get menu() {
+        return this._menuWrapper;
+    }
+    /**
+     * Activate a widget in its area.
+     */
+    activateById(id) {
+        const widget = find(this.widgets('main'), w => w.id === id);
+        if (widget) {
+            widget.activate();
+        }
+    }
+    /**
+     * Add a widget to the application shell.
+     *
+     * @param widget - The widget being added.
+     *
+     * @param area - Optional region in the shell into which the widget should
+     * be added.
+     *
+     * @param options - Optional open options.
+     *
+     */
+    add(widget, area, options) {
+        var _a;
+        const rank = (_a = options === null || options === void 0 ? void 0 : options.rank) !== null && _a !== void 0 ? _a : DEFAULT_RANK;
+        if (area === 'top') {
+            return this._topHandler.addWidget(widget, rank);
+        }
+        if (area === 'menu') {
+            return this._menuHandler.addWidget(widget, rank);
+        }
+        if (area === 'main' || area === undefined) {
+            if (this._main.widgets.length > 0) {
+                // do not add the widget if there is already one
+                return;
+            }
+            this._main.addWidget(widget);
+            this._main.update();
+            this._currentChanged.emit(void 0);
+        }
+    }
+    /**
+     * Collapse the top area and the spacer to make the view more compact.
+     */
+    collapseTop() {
+        this._topWrapper.setHidden(true);
+        this._spacer.setHidden(true);
+    }
+    /**
+     * Expand the top area to show the header and the spacer.
+     */
+    expandTop() {
+        this._topWrapper.setHidden(false);
+        this._spacer.setHidden(false);
+    }
+    /**
+     * Return the list of widgets for the given area.
+     *
+     * @param area The area
+     */
+    widgets(area) {
+        switch (area !== null && area !== void 0 ? area : 'main') {
+            case 'top':
+                return iter(this._topHandler.panel.widgets);
+            case 'menu':
+                return iter(this._menuHandler.panel.widgets);
+            case 'main':
+                return iter(this._main.widgets);
+            default:
+                throw new Error(`Invalid area: ${area}`);
+        }
+    }
+}
+/**
+ * A namespace for private module data.
+ */
+var Private;
+(function (Private) {
+    /**
+     * A less-than comparison function for side bar rank items.
+     */
+    function itemCmp(first, second) {
+        return first.rank - second.rank;
+    }
+    Private.itemCmp = itemCmp;
+    /**
+     * A class which manages a panel and sorts its widgets by rank.
+     */
+    class PanelHandler {
+        constructor() {
+            /**
+             * A message hook for child add/remove messages on the main area dock panel.
+             */
+            this._panelChildHook = (handler, msg) => {
+                switch (msg.type) {
+                    case 'child-added':
+                        {
+                            const widget = msg.child;
+                            // If we already know about this widget, we're done
+                            if (this._items.find(v => v.widget === widget)) {
+                                break;
+                            }
+                            // Otherwise, add to the end by default
+                            const rank = this._items[this._items.length - 1].rank;
+                            this._items.push({ widget, rank });
+                        }
+                        break;
+                    case 'child-removed':
+                        {
+                            const widget = msg.child;
+                            ArrayExt.removeFirstWhere(this._items, v => v.widget === widget);
+                        }
+                        break;
+                    default:
+                        break;
+                }
+                return true;
+            };
+            this._items = new Array();
+            this._panel = new Panel();
+            MessageLoop.installMessageHook(this._panel, this._panelChildHook);
+        }
+        /**
+         * Get the panel managed by the handler.
+         */
+        get panel() {
+            return this._panel;
+        }
+        /**
+         * Add a widget to the panel.
+         *
+         * If the widget is already added, it will be moved.
+         */
+        addWidget(widget, rank) {
+            widget.parent = null;
+            const item = { widget, rank };
+            const index = ArrayExt.upperBound(this._items, item, Private.itemCmp);
+            ArrayExt.insert(this._items, index, item);
+            this._panel.insertWidget(index, widget);
+        }
+    }
+    Private.PanelHandler = PanelHandler;
+})(Private || (Private = {}));

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@jupyter-notebook/application",
+  "version": "7.0.0-alpha.1",
+  "description": "Jupyter Notebook - Application",
+  "homepage": "https://github.com/jupyter/notebook",
+  "bugs": {
+    "url": "https://github.com/jupyter/notebook/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyter/notebook.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "Project Jupyter",
+  "sideEffects": [
+    "style/*.css",
+    "style/index.js"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "style": "style/index.css",
+  "directories": {
+    "lib": "lib/"
+  },
+  "files": [
+    "lib/*.d.ts",
+    "lib/*.js.map",
+    "lib/*.js",
+    "style/*.css",
+    "style/index.js"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "build:prod": "tsc -b",
+    "build:test": "tsc --build tsconfig.test.json",
+    "clean": "rimraf lib && rimraf tsconfig.tsbuildinfo",
+    "docs": "typedoc src",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "test:cov": "jest --collect-coverage",
+    "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand",
+    "test:debug:watch": "node --inspect-brk node_modules/.bin/jest --runInBand --watch",
+    "watch": "tsc -b --watch"
+  },
+  "dependencies": {
+    "@jupyterlab/application": "^4.0.0-alpha.5",
+    "@jupyterlab/coreutils": "^6.0.0-alpha.5",
+    "@jupyterlab/docregistry": "^4.0.0-alpha.5",
+    "@jupyterlab/rendermime-interfaces": "^4.0.0-alpha.5",
+    "@jupyterlab/ui-components": "^4.0.0-alpha.19",
+    "@lumino/algorithm": "^1.9.1",
+    "@lumino/coreutils": "^1.12.0",
+    "@lumino/messaging": "^1.10.1",
+    "@lumino/polling": "^1.10.0",
+    "@lumino/signaling": "^1.10.1",
+    "@lumino/widgets": "^1.31.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.11.6",
+    "@babel/preset-env": "^7.12.1",
+    "@jupyterlab/testutils": "^4.0.0-alpha.5",
+    "@types/jest": "^26.0.10",
+    "jest": "^26.4.2",
+    "rimraf": "~3.0.0",
+    "ts-jest": "^26.3.0",
+    "typescript": "~4.1.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "coreDependency": true
+  },
+  "styleModule": "style/index.js"
+}

package/style/base.css

@@ -0,0 +1,82 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+:root {
+  --jp-private-topbar-height: 28px;
+  /* Override the layout-2 color for the dark theme */
+  --md-grey-800: #323232;
+  --jp-notebook-max-width: 1200px;
+}
+
+body {
+  margin: 0;
+  padding: 0;
+  background: var(--jp-layout-color2);
+}
+
+#main {
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+}
+
+#top-panel-wrapper {
+  min-height: calc(1.5 * var(--jp-private-topbar-height));
+  border-bottom: var(--jp-border-width) solid var(--jp-border-color0);
+  background: var(--jp-layout-color1);
+}
+
+#top-panel {
+  display: flex;
+  min-height: calc(1.5 * var(--jp-private-topbar-height));
+  padding-left: 5px;
+  padding-right: 5px;
+  margin-left: auto;
+  margin-right: auto;
+  max-width: 1200px;
+}
+
+#menu-panel-wrapper {
+  min-height: var(--jp-private-topbar-height);
+  background: var(--jp-layout-color1);
+  border-bottom: var(--jp-border-width) solid var(--jp-border-color0);
+  box-shadow: var(--jp-elevation-z1);
+}
+
+#menu-panel {
+  display: flex;
+  min-height: var(--jp-private-topbar-height);
+  background: var(--jp-layout-color1);
+  padding-left: 5px;
+  padding-right: 5px;
+  margin-left: auto;
+  margin-right: auto;
+  max-width: var(--jp-notebook-max-width);
+}
+
+#main-panel {
+  box-shadow: var(--jp-elevation-z4);
+  margin-left: auto;
+  margin-right: auto;
+  max-width: var(--jp-notebook-max-width);
+}
+
+#spacer-widget {
+  min-height: 16px;
+}
+
+/* Special case notebooks as document oriented pages */
+
+body[data-notebook='notebooks'] #main-panel {
+  margin-left: unset;
+  margin-right: unset;
+  max-width: unset;
+}
+
+body[data-notebook='notebooks'] #spacer-widget {
+  min-height: unset;
+}

package/style/index.css

@@ -0,0 +1,10 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+@import url('~@jupyterlab/application/style/index.css');
+@import url('~@jupyterlab/mainmenu/style/index.css');
+@import url('~@jupyterlab/ui-components/style/index.css');
+
+@import url('./base.css');

package/style/index.js

@@ -0,0 +1,10 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+import '@jupyterlab/application/style/index.js';
+import '@jupyterlab/mainmenu/style/index.js';
+import '@jupyterlab/ui-components/style/index.js';
+
+import './base.css';