@jupyterlab/notebook-extension 4.0.0-alpha.20 → 4.0.0-alpha.21

package/src/index.ts

@@ -5,6 +5,8 @@
  * @module notebook-extension
  */
 
+import type { FieldProps } from '@rjsf/utils';
+
 import {
   ILabShell,
   ILayoutRestorer,
@@ -54,6 +56,7 @@ import {
   ILSPFeatureManager
 } from '@jupyterlab/lsp';
 import { IMainMenu } from '@jupyterlab/mainmenu';
+import { IMetadataFormProvider } from '@jupyterlab/metadataform';
 import * as nbformat from '@jupyterlab/nbformat';
 import {
   CommandEditStatus,
@@ -77,7 +80,11 @@ import {
 } from '@jupyterlab/notebook';
 import { IObservableList } from '@jupyterlab/observables';
 import { IPropertyInspectorProvider } from '@jupyterlab/property-inspector';
-import { IMarkdownParser, IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import {
+  IMarkdownParser,
+  IRenderMime,
+  IRenderMimeRegistry
+} from '@jupyterlab/rendermime';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { IStateDB } from '@jupyterlab/statedb';
 import { IStatusBar } from '@jupyterlab/statusbar';
@@ -91,6 +98,7 @@ import {
   cutIcon,
   duplicateIcon,
   fastForwardIcon,
+  IFormRenderer,
   IFormRendererRegistry,
   moveDownIcon,
   moveUpIcon,
@@ -102,7 +110,6 @@ import { CommandRegistry } from '@lumino/commands';
 import {
   JSONExt,
   JSONObject,
-  JSONValue,
   ReadonlyJSONValue,
   ReadonlyPartialJSONObject,
   UUID
@@ -111,6 +118,11 @@ import { DisposableSet, IDisposable } from '@lumino/disposable';
 import { Message, MessageLoop } from '@lumino/messaging';
 import { Menu, Panel, Widget } from '@lumino/widgets';
 import { logNotebookOutput } from './nboutput';
+import { ActiveCellTool } from './tool-widgets/activeCellToolWidget';
+import {
+  CellMetadataField,
+  NotebookMetadataField
+} from './tool-widgets/metadataEditorFields';
 
 /**
  * The command IDs used by the notebook plugin.
@@ -848,7 +860,7 @@ const tocPlugin: JupyterFrontEndPlugin<void> = {
     app: JupyterFrontEnd,
     tracker: INotebookTracker,
     tocRegistry: ITableOfContentsRegistry,
-    sanitizer: ISanitizer,
+    sanitizer: IRenderMime.ISanitizer,
     mdParser: IMarkdownParser | null
   ): void => {
     tocRegistry.add(new NotebookToCFactory(tracker, mdParser, sanitizer));
@@ -867,6 +879,156 @@ const languageServerPlugin: JupyterFrontEndPlugin<void> = {
   autoStart: true
 };
 
+const updateRawMimetype: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlab/notebook-extension:update-raw-mimetype',
+  autoStart: true,
+  requires: [INotebookTracker, IMetadataFormProvider, ITranslator],
+  activate: (
+    app: JupyterFrontEnd,
+    tracker: INotebookTracker,
+    metadataForms: IMetadataFormProvider,
+    translator: ITranslator
+  ) => {
+    const trans = translator.load('jupyterlab');
+    let formatsInitialized = false;
+
+    async function maybeInitializeFormats() {
+      if (formatsInitialized) {
+        return;
+      }
+      if (!metadataForms.get('commonToolsSection')) {
+        return;
+      }
+
+      const properties = metadataForms
+        .get('commonToolsSection')!
+        .getProperties('/raw_mimetype');
+
+      if (!properties) {
+        return;
+      }
+
+      tracker.widgetAdded.disconnect(maybeInitializeFormats);
+
+      formatsInitialized = true;
+
+      const services = app.serviceManager;
+      const response = await services.nbconvert.getExportFormats(false);
+      if (!response) {
+        return;
+      }
+
+      // convert exportList to palette and menu items
+      const formatList = Object.keys(response);
+      const formatLabels = Private.getFormatLabels(translator);
+      type enumeration = {
+        const: string;
+        title: string;
+      };
+      formatList.forEach(function (key) {
+        const mimetypeExists =
+          (properties!.oneOf as Array<enumeration>)?.filter(
+            value => value.const === key
+          ).length > 0;
+        if (!mimetypeExists) {
+          const altOption = trans.__(key[0].toUpperCase() + key.substr(1));
+          const option = formatLabels[key] ? formatLabels[key] : altOption;
+          const mimeTypeValue = response[key].output_mimetype;
+
+          (properties!.oneOf as Array<enumeration>)!.push({
+            const: mimeTypeValue,
+            title: option
+          });
+        }
+      });
+
+      metadataForms
+        .get('commonToolsSection')!
+        .setProperties('/raw_mimetype', properties);
+    }
+    tracker.widgetAdded.connect(maybeInitializeFormats);
+  }
+};
+
+/**
+ * Registering metadata editor fields.
+ */
+const customMetadataEditorFields: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlab/notebook-extension:metadata-editor',
+  autoStart: true,
+  requires: [INotebookTracker, IEditorServices, IFormRendererRegistry],
+  optional: [ITranslator],
+  activate: (
+    app: JupyterFrontEnd,
+    tracker: INotebookTracker,
+    editorServices: IEditorServices,
+    formRegistry: IFormRendererRegistry,
+    translator?: ITranslator
+  ) => {
+    const editorFactory: CodeEditor.Factory = options =>
+      editorServices.factoryService.newInlineEditor(options);
+    // Register the custom fields.
+    const cellComponent: IFormRenderer = {
+      fieldRenderer: (props: FieldProps) => {
+        return new CellMetadataField({
+          editorFactory,
+          tracker,
+          label: 'Cell metadata',
+          translator: translator
+        }).render(props);
+      }
+    };
+    formRegistry.addRenderer(
+      'notebook-extension:metadata-editor.cell-metadata',
+      cellComponent
+    );
+
+    const notebookComponent: IFormRenderer = {
+      fieldRenderer: (props: FieldProps) => {
+        return new NotebookMetadataField({
+          editorFactory,
+          tracker,
+          label: 'Notebook metadata',
+          translator: translator
+        }).render(props);
+      }
+    };
+    formRegistry.addRenderer(
+      'notebook-extension:metadata-editor.notebook-metadata',
+      notebookComponent
+    );
+  }
+};
+
+/**
+ * Registering active cell field.
+ */
+const activeCellTool: JupyterFrontEndPlugin<void> = {
+  id: '@jupyterlab/notebook-extension:active-cell-tool',
+  autoStart: true,
+  requires: [INotebookTracker, IFormRendererRegistry, IEditorLanguageRegistry],
+  activate: (
+    // Register the custom field.
+    app: JupyterFrontEnd,
+    tracker: INotebookTracker,
+    formRegistry: IFormRendererRegistry,
+    languages: IEditorLanguageRegistry
+  ) => {
+    const component: IFormRenderer = {
+      fieldRenderer: (props: FieldProps) => {
+        return new ActiveCellTool({
+          tracker,
+          languages
+        }).render(props);
+      }
+    };
+    formRegistry.addRenderer(
+      'notebook-extension:active-cell-tool.renderer',
+      component
+    );
+  }
+};
+
 /**
  * Export the plugins as default.
  */
@@ -888,7 +1050,10 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   completerPlugin,
   searchProvider,
   tocPlugin,
-  languageServerPlugin
+  languageServerPlugin,
+  updateRawMimetype,
+  customMetadataEditorFields,
+  activeCellTool
 ];
 export default plugins;
 
@@ -907,23 +1072,6 @@ function activateNotebookTools(
   const trans = translator.load('jupyterlab');
   const id = 'notebook-tools';
   const notebookTools = new NotebookTools({ tracker, translator });
-  const activeCellTool = new NotebookTools.ActiveCellTool(languages);
-  const editable = NotebookTools.createEditableToggle(translator);
-  const slideShow = NotebookTools.createSlideShowSelector(translator);
-  const tocBaseNumbering = NotebookTools.createToCBaseNumbering(translator);
-  const editorFactory: CodeEditor.Factory = options =>
-    editorServices.factoryService.newInlineEditor(options);
-  const cellMetadataEditor = new NotebookTools.CellMetadataEditorTool({
-    editorFactory,
-    collapsed: false,
-    translator
-  });
-  const notebookMetadataEditor = new NotebookTools.NotebookMetadataEditorTool({
-    editorFactory,
-    translator
-  });
-
-  const services = app.serviceManager;
 
   // Create message hook for triggers to save to the database.
   const hook = (sender: any, message: Message): boolean => {
@@ -940,77 +1088,10 @@ function activateNotebookTools(
     }
     return true;
   };
-  const optionsMap: { [key: string]: JSONValue } = {};
-  optionsMap.None = null;
-
-  let formatsInitialized = false;
-
-  async function maybeInitializeFormats() {
-    if (formatsInitialized) {
-      return;
-    }
-
-    tracker.widgetAdded.disconnect(maybeInitializeFormats);
-
-    formatsInitialized = true;
-
-    const response = await services.nbconvert.getExportFormats(false);
-    if (!response) {
-      return;
-    }
-    /**
-     * The excluded Cell Inspector Raw NbConvert Formats
-     * (returned from nbconvert's export list)
-     */
-    const rawFormatExclude = ['pdf', 'slides', 'script', 'notebook', 'custom'];
-    let optionValueArray: any = [
-      [trans.__('PDF'), 'pdf'],
-      [trans.__('Slides'), 'slides'],
-      [trans.__('Script'), 'script'],
-      [trans.__('Notebook'), 'notebook'],
-      [trans.__('Custom'), 'custom']
-    ];
-
-    // convert exportList to palette and menu items
-    const formatList = Object.keys(response);
-    const formatLabels = Private.getFormatLabels(translator);
-    formatList.forEach(function (key) {
-      if (rawFormatExclude.indexOf(key) === -1) {
-        const altOption = trans.__(key[0].toUpperCase() + key.substr(1));
-        const option = formatLabels[key] ? formatLabels[key] : altOption;
-        const mimeTypeValue = response[key].output_mimetype;
-        optionValueArray.push([option, mimeTypeValue]);
-      }
-    });
-    const nbConvert = NotebookTools.createNBConvertSelector(
-      optionValueArray,
-      translator
-    );
-    notebookTools.addItem({ tool: nbConvert, section: 'common', rank: 3 });
-  }
-
-  tracker.widgetAdded.connect(maybeInitializeFormats);
-
   notebookTools.title.icon = buildIcon;
   notebookTools.title.caption = trans.__('Notebook Tools');
   notebookTools.id = id;
 
-  notebookTools.addItem({ tool: activeCellTool, section: 'common', rank: 1 });
-  notebookTools.addItem({ tool: editable, section: 'common', rank: 2 });
-  notebookTools.addItem({ tool: slideShow, section: 'common', rank: 3 });
-  notebookTools.addItem({ tool: tocBaseNumbering, section: 'common', rank: 4 });
-
-  notebookTools.addItem({
-    tool: cellMetadataEditor,
-    section: 'advanced',
-    rank: 1
-  });
-  notebookTools.addItem({
-    tool: notebookMetadataEditor,
-    section: 'advanced',
-    rank: 2
-  });
-
   MessageLoop.installMessageHook(notebookTools, hook);
 
   if (inspectorProvider) {
@@ -1657,9 +1738,8 @@ function activateNotebookHandler(
       showEditorForReadOnlyMarkdown: settings.get(
         'showEditorForReadOnlyMarkdown'
       ).composite as boolean,
-      disableDocumentWideUndoRedo: settings.get(
-        'experimentalDisableDocumentWideUndoRedo'
-      ).composite as boolean,
+      disableDocumentWideUndoRedo: !settings.get('documentWideUndoRedo')
+        .composite as boolean,
       renderingLayout: settings.get('renderingLayout').composite as
         | 'default'
         | 'side-by-side',
@@ -1691,8 +1771,8 @@ function activateNotebookHandler(
     factory.shutdownOnClose = settings.get('kernelShutdown')
       .composite as boolean;
 
-    modelFactory.disableDocumentWideUndoRedo = settings.get(
-      'experimentalDisableDocumentWideUndoRedo'
+    modelFactory.disableDocumentWideUndoRedo = !settings.get(
+      'documentWideUndoRedo'
     ).composite as boolean;
 
     updateTracker({
@@ -1805,7 +1885,7 @@ function activateNotebookCompleterService(
   notebooks: INotebookTracker,
   manager: ICompletionProviderManager | null,
   translator: ITranslator | null,
-  appSanitizer: ISanitizer | null
+  appSanitizer: IRenderMime.ISanitizer | null
 ): void {
   if (!manager) {
     return;
@@ -1976,9 +2056,43 @@ function addCommands(
     }
   );
 
+  tracker.selectionChanged.connect(() => {
+    commands.notifyCommandChanged(CommandIDs.duplicateBelow);
+    commands.notifyCommandChanged(CommandIDs.deleteCell);
+    commands.notifyCommandChanged(CommandIDs.copy);
+    commands.notifyCommandChanged(CommandIDs.cut);
+    commands.notifyCommandChanged(CommandIDs.pasteBelow);
+    commands.notifyCommandChanged(CommandIDs.pasteAbove);
+    commands.notifyCommandChanged(CommandIDs.pasteAndReplace);
+    commands.notifyCommandChanged(CommandIDs.moveUp);
+    commands.notifyCommandChanged(CommandIDs.moveDown);
+    commands.notifyCommandChanged(CommandIDs.run);
+    commands.notifyCommandChanged(CommandIDs.runAll);
+    commands.notifyCommandChanged(CommandIDs.runAndAdvance);
+    commands.notifyCommandChanged(CommandIDs.runAndInsert);
+  });
+  tracker.activeCellChanged.connect(() => {
+    commands.notifyCommandChanged(CommandIDs.moveUp);
+    commands.notifyCommandChanged(CommandIDs.moveDown);
+  });
+
   commands.addCommand(CommandIDs.runAndAdvance, {
-    label: trans.__('Run Selected Cells'),
-    caption: trans.__('Run the selected cells'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Run Selected Cell',
+        'Run Selected Cells',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Run this cell and advance',
+        'Run these %1 cells and advance',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -1991,8 +2105,14 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.run, {
-    label: trans.__('Run Selected Cells and Do not Advance'),
-    caption: trans.__('Run the selected cells and do not advance'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Run Selected Cell and Do not Advance',
+        'Run Selected Cells and Do not Advance',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2005,7 +2125,14 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.runAndInsert, {
-    label: trans.__('Run Selected Cells and Insert Below'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Run Selected Cell and Insert Below',
+        'Run Selected Cells and Insert Below',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2270,8 +2397,22 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.cut, {
-    label: trans.__('Cut Cells'),
-    caption: trans.__('Cut the selected cells'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Cut Cell',
+        'Cut Cells',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Cut this cell',
+        'Cut these %1 cells',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2283,8 +2424,22 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.copy, {
-    label: trans.__('Copy Cells'),
-    caption: trans.__('Copy the selected cells'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Copy Cell',
+        'Copy Cells',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Copy this cell',
+        'Copy these %1 cells',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2296,8 +2451,22 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.pasteBelow, {
-    label: trans.__('Paste Cells Below'),
-    caption: trans.__('Paste cells from the clipboard'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Paste Cell Below',
+        'Paste Cells Below',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Paste this cell from the clipboard',
+        'Paste these %1 cells from the clipboard',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2309,7 +2478,22 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.pasteAbove, {
-    label: trans.__('Paste Cells Above'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Paste Cell Above',
+        'Paste Cells Above',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Paste this cell from the clipboard',
+        'Paste these %1 cells from the clipboard',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2320,10 +2504,22 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.duplicateBelow, {
-    label: trans.__('Duplicate Cells Below'),
-    caption: trans.__(
-      'Copy the selected cells and paste them below the selection'
-    ),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Duplicate Cell Below',
+        'Duplicate Cells Below',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Create a duplicate of this cell below',
+        'Create duplicates of %1 cells below',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2335,7 +2531,14 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.pasteAndReplace, {
-    label: trans.__('Paste Cells and Replace'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Paste Cell and Replace',
+        'Paste Cells and Replace',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2346,7 +2549,23 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.deleteCell, {
-    label: trans.__('Delete Cells'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Delete Cell',
+        'Delete Cells',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Delete this cell',
+        'Delete these %1 cells',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2402,6 +2621,7 @@ function addCommands(
   });
   commands.addCommand(CommandIDs.insertAbove, {
     label: trans.__('Insert Cell Above'),
+    caption: trans.__('Insert a cell above'),
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2562,7 +2782,22 @@ function addCommands(
     isEnabled
   });
   commands.addCommand(CommandIDs.moveUp, {
-    label: trans.__('Move Cells Up'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Move Cell Up',
+        'Move Cells Up',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Move this cell up',
+        'Move these %1 cells up',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2574,11 +2809,32 @@ function addCommands(
         );
       }
     },
-    isEnabled,
+    isEnabled: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      if (!current) {
+        return false;
+      }
+      return current.content.activeCellIndex >= 1;
+    },
     icon: args => (args.toolbar ? moveUpIcon : undefined)
   });
   commands.addCommand(CommandIDs.moveDown, {
-    label: trans.__('Move Cells Down'),
+    label: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Move Cell Down',
+        'Move Cells Down',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
+    caption: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      return trans._n(
+        'Move this cell down',
+        'Move these %1 cells down',
+        current?.content.selectedCells.length ?? 1
+      );
+    },
     execute: args => {
       const current = getCurrent(tracker, shell, args);
 
@@ -2590,7 +2846,15 @@ function addCommands(
         );
       }
     },
-    isEnabled,
+    isEnabled: args => {
+      const current = getCurrent(tracker, shell, { ...args, activate: false });
+      if (!current || !current.content.model) {
+        return false;
+      }
+
+      const length = current.content.model.cells.length;
+      return current.content.activeCellIndex < length - 1;
+    },
     icon: args => (args.toolbar ? moveDownIcon : undefined)
   });
   commands.addCommand(CommandIDs.toggleAllLines, {
@@ -2667,7 +2931,11 @@ function addCommands(
       const current = getCurrent(tracker, shell, args);
 
       if (current) {
-        return current.content.activeCell?.editor?.redo();
+        const cell = current.content.activeCell;
+        if (cell) {
+          cell.inputHidden = false;
+          return cell.editor?.redo();
+        }
       }
     }
   });
@@ -2677,7 +2945,11 @@ function addCommands(
       const current = getCurrent(tracker, shell, args);
 
       if (current) {
-        return current.content.activeCell?.editor?.undo();
+        const cell = current.content.activeCell;
+        if (cell) {
+          cell.inputHidden = false;
+          return cell.editor?.undo();
+        }
       }
     }
   });