@jupyter-notebook/application-extension 7.6.1 → 7.7.0-alpha.1

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';
@@ -274,7 +275,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'));
@@ -1058,6 +1059,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 +1088,7 @@ const plugins = [
     pathOpener,
     paths,
     rendermime,
+    settingsConnector,
     shell,
     sidePanelVisibility,
     shortcuts,

package/lib/settingconnector.d.ts

@@ -0,0 +1,31 @@
+import type { ISettingConnector, ISettingRegistry } from '@jupyterlab/settingregistry';
+import type { IDataConnector } from '@jupyterlab/statedb';
+import { DataConnector } from '@jupyterlab/statedb';
+/**
+ * A data connector for fetching settings.
+ *
+ * #### Notes
+ * This connector is based on the default JupyterLab setting connector,
+ * and additionally overrides the default values of some settings.
+ */
+export declare class SettingConnector extends DataConnector<ISettingRegistry.IPlugin, string> implements ISettingConnector {
+    constructor(connector: IDataConnector<ISettingRegistry.IPlugin, string>);
+    /**
+     * Fetch settings for a plugin.
+     * @param id - The plugin ID
+     *
+     * #### Notes
+     * The REST API requests are throttled at one request per plugin per 100ms.
+     */
+    fetch(id: string): Promise<ISettingRegistry.IPlugin | undefined>;
+    list(query: 'ids'): Promise<{
+        ids: string[];
+    }>;
+    list(query: 'active' | 'all'): Promise<{
+        ids: string[];
+        values: ISettingRegistry.IPlugin[];
+    }>;
+    save(id: string, raw: string): Promise<void>;
+    private _connector;
+    private _throttlers;
+}

package/lib/settingconnector.js

@@ -0,0 +1,97 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { PageConfig } from '@jupyterlab/coreutils';
+import { DataConnector } from '@jupyterlab/statedb';
+import { Throttler } from '@lumino/polling';
+/**
+ * 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,
+    },
+};
+/**
+ * A data connector for fetching settings.
+ *
+ * #### Notes
+ * This connector is based on the default JupyterLab setting connector,
+ * and additionally overrides the default values of some settings.
+ */
+export class SettingConnector extends DataConnector {
+    constructor(connector) {
+        super();
+        this._throttlers = Object.create(null);
+        this._connector = connector;
+    }
+    /**
+     * Fetch settings for a plugin.
+     * @param id - The plugin ID
+     *
+     * #### Notes
+     * The REST API requests are throttled at one request per plugin per 100ms.
+     */
+    fetch(id) {
+        const throttlers = this._throttlers;
+        if (!(id in throttlers)) {
+            throttlers[id] = new Throttler(async () => {
+                const plugin = await this._connector.fetch(id);
+                return plugin && Private.overrideDefaults(plugin);
+            }, 100);
+        }
+        return throttlers[id].invoke();
+    }
+    async list(query = 'all') {
+        const { isDisabled } = PageConfig.Extension;
+        const { ids, values } = await this._connector.list(query === 'ids' ? 'ids' : undefined);
+        if (query === 'ids') {
+            return { ids };
+        }
+        if (query === 'all') {
+            return { ids, values: values.map(Private.overrideDefaults) };
+        }
+        return {
+            ids: ids.filter((id) => !isDisabled(id)),
+            values: values
+                .filter(({ id }) => !isDisabled(id))
+                .map(Private.overrideDefaults),
+        };
+    }
+    async save(id, raw) {
+        await this._connector.save(id, raw);
+    }
+}
+/**
+ * A namespace for private module data.
+ */
+var Private;
+(function (Private) {
+    /**
+     * 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;
+    }
+    Private.overrideDefaults = overrideDefaults;
+})(Private || (Private = {}));

package/package.json

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