@jupyterlab/notebook-extension 4.6.0-alpha.5 → 4.6.0-beta.1

package/lib/index.js

@@ -1,14 +1,15 @@
 // Copyright (c) Jupyter Development Team.
 // Distributed under the terms of the Modified BSD License.
+/* eslint-disable @typescript-eslint/no-explicit-any */
 /**
  * @packageDocumentation
  * @module notebook-extension
  */
 import { ILabShell, ILayoutRestorer, IRouter } from '@jupyterlab/application';
-import { createToolbarFactory, Dialog, ICommandPalette, IKernelStatusModel, InputDialog, ISanitizer, ISessionContextDialogs, IToolbarWidgetRegistry, MainAreaWidget, Sanitizer, SemanticCommand, SessionContextDialogs, showDialog, Toolbar, WidgetTracker } from '@jupyterlab/apputils';
+import { Clipboard, createToolbarFactory, Dialog, ICommandPalette, IKernelStatusModel, InputDialog, ISanitizer, ISessionContextDialogs, IToolbarWidgetRegistry, MainAreaWidget, Sanitizer, SemanticCommand, SessionContextDialogs, showDialog, Toolbar, WidgetTracker } from '@jupyterlab/apputils';
 import { MarkdownCell } from '@jupyterlab/cells';
 import { IEditorServices, IPositionModel } from '@jupyterlab/codeeditor';
-import { PageConfig } from '@jupyterlab/coreutils';
+import { compareVersions, PageConfig } from '@jupyterlab/coreutils';
 import { IEditorExtensionRegistry, IEditorLanguageRegistry } from '@jupyterlab/codemirror';
 import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { IDocumentManager } from '@jupyterlab/docmanager';
@@ -127,6 +128,8 @@ var CommandIDs;
     CommandIDs.disableOutputScrolling = 'notebook:disable-output-scrolling';
     CommandIDs.toggleOutputScrolling = 'notebook:toggle-output-scrolling';
     CommandIDs.selectLastRunCell = 'notebook:select-last-run-cell';
+    CommandIDs.selectLastModifiedCell = 'notebook:select-last-modified-cell';
+    CommandIDs.selectNextModifiedCell = 'notebook:select-next-modified-cell';
     CommandIDs.replaceSelection = 'notebook:replace-selection';
     CommandIDs.autoClosingBrackets = 'notebook:toggle-autoclosing-brackets';
     CommandIDs.toggleCollapseCmd = 'notebook:toggle-heading-collapse';
@@ -139,6 +142,9 @@ var CommandIDs;
     CommandIDs.accessPreviousHistory = 'notebook:access-previous-history-entry';
     CommandIDs.accessNextHistory = 'notebook:access-next-history-entry';
     CommandIDs.virtualScrollbar = 'notebook:toggle-virtual-scrollbar';
+    CommandIDs.copySelectedtext = 'notebook:copy-selected-text';
+    CommandIDs.pasteText = 'notebook:paste-text';
+    CommandIDs.cutSelectedtext = 'notebook:cut-selected-text';
 })(CommandIDs || (CommandIDs = {}));
 /**
  * The name of the factory that creates notebooks.
@@ -391,23 +397,40 @@ export const exportPlugin = {
                     : formatLabel;
             },
             execute: async (args) => {
-                var _a, _b;
+                var _a, _b, _c;
                 const current = getCurrent(tracker, shell, args);
                 if (!current) {
                     return;
                 }
                 const { context } = current;
+                const serverVersion = PageConfig.getNotebookVersion();
+                const supportsHTMLSanitizationOption = compareVersions(serverVersion, [4, 0, 0]) <
+                    0 /* Jupyter Server only */ &&
+                    compareVersions(serverVersion, [2, 18, 0]) >= 0;
+                let sanitizeHtml = false;
+                if (args['format'] === 'html' && supportsHTMLSanitizationOption) {
+                    const result = await InputDialog.getBoolean({
+                        title: trans.__('Export as HTML'),
+                        label: trans.__('Sanitize HTML output'),
+                        value: true
+                    });
+                    if (!result.button.accept) {
+                        return;
+                    }
+                    sanitizeHtml = (_a = result.value) !== null && _a !== void 0 ? _a : false;
+                }
                 const exportOptions = {
                     format: args['format'],
                     path: current.context.path,
                     exporterOptions: {
-                        download: true
+                        download: true,
+                        sanitizeHtml
                     }
                 };
                 if (context.model.dirty && !context.model.readOnly) {
                     await context.save();
                 }
-                return (_b = (_a = services.nbconvert).exportAs) === null || _b === void 0 ? void 0 : _b.call(_a, exportOptions);
+                return (_c = (_b = services.nbconvert).exportAs) === null || _c === void 0 ? void 0 : _c.call(_b, exportOptions);
             },
             isEnabled,
             describedBy: {
@@ -654,7 +677,7 @@ const tocPlugin = {
     optional: [IMarkdownParser, ISettingRegistry],
     autoStart: true,
     activate: (app, tracker, tocRegistry, sanitizer, mdParser, settingRegistry) => {
-        const nbTocFactory = new NotebookToCFactory(tracker, mdParser, sanitizer);
+        const nbTocFactory = new NotebookToCFactory(tracker, mdParser, sanitizer, app.commands);
         tocRegistry.add(nbTocFactory);
         if (settingRegistry) {
             Promise.all([app.restored, settingRegistry.load(trackerPlugin.id)])
@@ -842,7 +865,8 @@ const openWithNoKernelPlugin = {
                         label: trans.__('Notebook (no kernel)'),
                         factory: FACTORY,
                         kernelPreference: {
-                            shouldStart: false
+                            shouldStart: false,
+                            shouldReuse: false
                         }
                     }
                 }));
@@ -904,6 +928,10 @@ function activateNotebookTools(app, tracker, editorServices, languages, state, t
         return true;
     };
     notebookTools.title.icon = buildIcon;
+    notebookTools.title.dataset = {
+        ...notebookTools.title.dataset,
+        jpTabLabel: trans.__('Notebook Tools')
+    };
     notebookTools.title.caption = trans.__('Notebook Tools');
     notebookTools.id = id;
     MessageLoop.installMessageHook(notebookTools, hook);
@@ -1878,6 +1906,9 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
     tracker.selectionChanged.connect(() => {
         commands.notifyCommandChanged(CommandIDs.duplicateBelow);
         commands.notifyCommandChanged(CommandIDs.deleteCell);
+        commands.notifyCommandChanged(CommandIDs.copySelectedtext);
+        commands.notifyCommandChanged(CommandIDs.pasteText);
+        commands.notifyCommandChanged(CommandIDs.cutSelectedtext);
         commands.notifyCommandChanged(CommandIDs.copy);
         commands.notifyCommandChanged(CommandIDs.cut);
         commands.notifyCommandChanged(CommandIDs.pasteBelow);
@@ -1894,6 +1925,16 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
         commands.notifyCommandChanged(CommandIDs.deleteCell);
         commands.notifyCommandChanged(CommandIDs.moveUp);
         commands.notifyCommandChanged(CommandIDs.moveDown);
+        commands.notifyCommandChanged(CommandIDs.selectLastModifiedCell);
+        commands.notifyCommandChanged(CommandIDs.selectNextModifiedCell);
+    });
+    tracker.widgetAdded.connect((_, panel) => {
+        panel.content.stateChanged.connect((_, args) => {
+            if (args.name === 'lastModifiedCellStack') {
+                commands.notifyCommandChanged(CommandIDs.selectLastModifiedCell);
+                commands.notifyCommandChanged(CommandIDs.selectNextModifiedCell);
+            }
+        });
     });
     commands.addCommand(CommandIDs.runAndAdvance, {
         label: args => {
@@ -2589,6 +2630,143 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
             }
         }
     });
+    commands.addCommand(CommandIDs.copySelectedtext, {
+        label: trans.__('Copy Selected Text'),
+        caption: trans.__('Copy selected text from the active cell or output area'),
+        execute: async (args) => {
+            var _a;
+            const current = getCurrent(tracker, shell, args);
+            if (!current) {
+                return;
+            }
+            // copying from the editor (input area)
+            const editor = (_a = current.content.activeCell) === null || _a === void 0 ? void 0 : _a.editor;
+            if (editor) {
+                const selection = editor.getSelection();
+                const start = editor.getOffsetAt(selection.start);
+                const end = editor.getOffsetAt(selection.end);
+                const text = editor.model.sharedModel.getSource().slice(start, end);
+                if (text) {
+                    await navigator.clipboard.writeText(text);
+                    return;
+                }
+            }
+            // fallback to DOM selection (output)
+            const domSelection = window.getSelection();
+            const selectedText = domSelection === null || domSelection === void 0 ? void 0 : domSelection.toString();
+            if (selectedText && selectedText.trim().length > 0) {
+                await navigator.clipboard.writeText(selectedText);
+            }
+        },
+        isEnabled: args => {
+            var _a;
+            const current = getCurrent(tracker, shell, { ...args, activate: false });
+            if (!current) {
+                return false;
+            }
+            const editor = (_a = current.content.activeCell) === null || _a === void 0 ? void 0 : _a.editor;
+            if (editor) {
+                const selection = editor.getSelection();
+                const hasEditorSelection = selection.start.line !== selection.end.line ||
+                    selection.start.column !== selection.end.column;
+                if (hasEditorSelection) {
+                    return true;
+                }
+            }
+            // Check for text selection in output area
+            const domSelection = window.getSelection();
+            return !!domSelection && domSelection.toString().trim().length > 0;
+        },
+        describedBy: {
+            args: {
+                type: 'object',
+                properties: {}
+            }
+        }
+    });
+    commands.addCommand(CommandIDs.cutSelectedtext, {
+        label: trans.__('Cut Selected Text'),
+        caption: trans.__('Cut selected text from the active cell or output area'),
+        execute: async (args) => {
+            var _a, _b;
+            const current = getCurrent(tracker, shell, args);
+            if (!current) {
+                return;
+            }
+            const editor = (_a = current.content.activeCell) === null || _a === void 0 ? void 0 : _a.editor;
+            if (editor) {
+                const selection = editor.getSelection();
+                const start = editor.getOffsetAt(selection.start);
+                const end = editor.getOffsetAt(selection.end);
+                const text = editor.model.sharedModel.getSource().slice(start, end);
+                if (text) {
+                    await navigator.clipboard.writeText(text);
+                    (_b = editor.replaceSelection) === null || _b === void 0 ? void 0 : _b.call(editor, '');
+                    return;
+                }
+            }
+        },
+        isEnabled: args => {
+            var _a;
+            const current = getCurrent(tracker, shell, { ...args, activate: false });
+            if (!current) {
+                return false;
+            }
+            const editor = (_a = current.content.activeCell) === null || _a === void 0 ? void 0 : _a.editor;
+            if (!editor) {
+                return false;
+            }
+            const selection = editor.getSelection();
+            const hasEditorSelection = selection.start.line !== selection.end.line ||
+                selection.start.column !== selection.end.column;
+            return hasEditorSelection;
+        },
+        describedBy: {
+            args: {
+                type: 'object',
+                properties: {}
+            }
+        }
+    });
+    commands.addCommand(CommandIDs.pasteText, {
+        label: trans.__('Paste Text'),
+        caption: trans.__('Paste text from the clipboard into the active cell editor'),
+        execute: async (args) => {
+            var _a, _b;
+            const current = getCurrent(tracker, shell, args);
+            if (!current) {
+                return;
+            }
+            const editor = (_a = current.content.activeCell) === null || _a === void 0 ? void 0 : _a.editor;
+            if (!editor) {
+                return;
+            }
+            try {
+                const text = await navigator.clipboard.readText();
+                if (text) {
+                    (_b = editor.replaceSelection) === null || _b === void 0 ? void 0 : _b.call(editor, text);
+                }
+            }
+            catch (err) {
+                // browser limitation fallback (e.g Firefox)
+                Clipboard.showPasteUnavailableDialog(trans);
+            }
+        },
+        isEnabled: args => {
+            var _a;
+            const current = getCurrent(tracker, shell, { ...args, activate: false });
+            if (!current) {
+                return false;
+            }
+            return !!((_a = current.content.activeCell) === null || _a === void 0 ? void 0 : _a.editor);
+        },
+        describedBy: {
+            args: {
+                type: 'object',
+                properties: {}
+            }
+        }
+    });
     commands.addCommand(CommandIDs.split, {
         label: trans.__('Split Cell'),
         execute: args => {
@@ -2615,7 +2793,15 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
                 return NotebookActions.mergeCells(current.content, false, addExtraLine, translator);
             }
         },
-        isEnabled,
+        isVisible: args => {
+            const current = getCurrent(tracker, shell, { ...args, activate: false });
+            if (!current) {
+                return false;
+            }
+            // Enable only if more than one cell is selected
+            const notebook = current.content;
+            return notebook && notebook.selectedCells.length > 1;
+        },
         describedBy: {
             args: {
                 type: 'object',
@@ -3534,6 +3720,44 @@ function addCommands(app, tracker, translator, sessionDialogs, settings, isEnabl
             }
         }
     });
+    commands.addCommand(CommandIDs.selectLastModifiedCell, {
+        label: trans.__('Select Last Modified Cell'),
+        execute: async (args) => {
+            const current = getCurrent(tracker, shell, args);
+            if (current) {
+                await NotebookActions.selectLastModifiedCell(current.content);
+            }
+        },
+        isEnabled: args => {
+            const current = getCurrent(tracker, shell, { ...args, activate: false });
+            return !!current && current.content.hasNavigableModifiedCellBack();
+        },
+        describedBy: {
+            args: {
+                type: 'object',
+                properties: {}
+            }
+        }
+    });
+    commands.addCommand(CommandIDs.selectNextModifiedCell, {
+        label: trans.__('Select Next Modified Cell'),
+        execute: async (args) => {
+            const current = getCurrent(tracker, shell, args);
+            if (current) {
+                await NotebookActions.selectNextModifiedCell(current.content);
+            }
+        },
+        isEnabled: args => {
+            const current = getCurrent(tracker, shell, { ...args, activate: false });
+            return !!current && current.content.hasNavigableModifiedCellForward();
+        },
+        describedBy: {
+            args: {
+                type: 'object',
+                properties: {}
+            }
+        }
+    });
     commands.addCommand(CommandIDs.replaceSelection, {
         label: trans.__('Replace Selection in Notebook Cell'),
         execute: args => {
@@ -3764,6 +3988,9 @@ function populatePalette(palette, translator) {
         CommandIDs.pasteAbove,
         CommandIDs.pasteAndReplace,
         CommandIDs.deleteCell,
+        CommandIDs.copySelectedtext,
+        CommandIDs.pasteText,
+        CommandIDs.cutSelectedtext,
         CommandIDs.split,
         CommandIDs.merge,
         CommandIDs.mergeAbove,
@@ -3802,7 +4029,9 @@ function populatePalette(palette, translator) {
         CommandIDs.toggleRenderSideBySideCurrentNotebook,
         CommandIDs.setSideBySideRatio,
         CommandIDs.enableOutputScrolling,
-        CommandIDs.disableOutputScrolling
+        CommandIDs.disableOutputScrolling,
+        CommandIDs.selectLastModifiedCell,
+        CommandIDs.selectNextModifiedCell
     ].forEach(command => {
         palette.addItem({ command, category });
     });