@jupyterlab/notebook 4.6.0-alpha.3 → 4.6.0-alpha.5

package/src/actions.tsx

@@ -11,12 +11,7 @@ import {
   showDialog,
   SystemClipboard
 } from '@jupyterlab/apputils';
-import type {
-  Cell,
-  CodeCell,
-  ICellModel,
-  ICodeCellModel
-} from '@jupyterlab/cells';
+import type { Cell, CodeCell, ICodeCellModel } from '@jupyterlab/cells';
 import {
   CodeCellModel,
   isMarkdownCellModel,
@@ -146,11 +141,32 @@ export class NotebookActions {
  * A namespace for `NotebookActions` static methods.
  */
 export namespace NotebookActions {
+  const READ_ONLY_ACTION_AUTO_CLOSE = 5000;
+
+  function notifySplitReadOnlyAction(translator?: ITranslator): void {
+    const trans = (translator ?? nullTranslator).load('jupyterlab');
+    Notification.error(trans.__('The cell is read-only and cannot be split.'), {
+      autoClose: READ_ONLY_ACTION_AUTO_CLOSE
+    });
+  }
+
+  function notifyMergeReadOnlyAction(translator?: ITranslator): void {
+    const trans = (translator ?? nullTranslator).load('jupyterlab');
+    Notification.error(
+      trans.__('The cell is read-only and cannot be merged.'),
+      {
+        autoClose: READ_ONLY_ACTION_AUTO_CLOSE
+      }
+    );
+  }
+
   /**
    * Split the active cell into two or more cells.
    *
    * @param notebook The target notebook widget.
    *
+   * @param translator - Application translator.
+   *
    * #### Notes
    * It will preserve the existing mode.
    * The last cell will be activated if no selection is found.
@@ -165,10 +181,17 @@ export namespace NotebookActions {
    * This action can be undone.
    * The original cell is preserved to maintain kernel connections.
    */
-  export function splitCell(notebook: Notebook): void {
+  export function splitCell(
+    notebook: Notebook,
+    translator?: ITranslator
+  ): void {
     if (!notebook.model || !notebook.activeCell) {
       return;
     }
+    if (notebook.activeCell.model.getMetadata('editable') === false) {
+      notifySplitReadOnlyAction(translator);
+      return;
+    }
 
     const state = Private.getState(notebook);
     // We force the notebook back in edit mode as splitting a cell
@@ -305,6 +328,8 @@ export namespace NotebookActions {
    * @param addExtraLine - Whether to add an extra newline between merged cell contents
    *    (true, default) or use only a single newline (false).
    *
+   * @param translator - Application translator.
+   *
    * #### Notes
    * The widget mode will be preserved.
    * If only one cell is selected and `mergeAbove` is true, the above cell will be selected.
@@ -317,7 +342,8 @@ export namespace NotebookActions {
   export function mergeCells(
     notebook: Notebook,
     mergeAbove: boolean = false,
-    addExtraLine: boolean = true
+    addExtraLine: boolean = true,
+    translator?: ITranslator
   ): void {
     if (!notebook.model || !notebook.activeCell) {
       return;
@@ -331,10 +357,15 @@ export namespace NotebookActions {
     const primary = notebook.activeCell;
     const active = notebook.activeCellIndex;
     const attachments: nbformat.IAttachments = {};
+    let hasReadOnlyCell = false;
 
     // Get the cells to merge.
     notebook.widgets.forEach((child, index) => {
       if (notebook.isSelectedOrActive(child)) {
+        if (child.model.getMetadata('editable') === false) {
+          hasReadOnlyCell = true;
+          return;
+        }
         toMerge.push(child.model.sharedModel.getSource());
         if (index !== active) {
           toDelete.push(index);
@@ -349,6 +380,11 @@ export namespace NotebookActions {
       }
     });
 
+    if (hasReadOnlyCell) {
+      notifyMergeReadOnlyAction(translator);
+      return;
+    }
+
     // Check for only a single cell selected.
     if (toMerge.length === 1) {
       // Merge with the cell above when mergeAbove is true
@@ -357,6 +393,12 @@ export namespace NotebookActions {
         if (active === 0) {
           return;
         }
+        if (
+          notebook.widgets[active - 1].model.getMetadata('editable') === false
+        ) {
+          notifyMergeReadOnlyAction(translator);
+          return;
+        }
         // Otherwise merge with the previous cell.
         const cellModel = cells.get(active - 1);
 
@@ -367,6 +409,12 @@ export namespace NotebookActions {
         if (active === cells.length - 1) {
           return;
         }
+        if (
+          notebook.widgets[active + 1].model.getMetadata('editable') === false
+        ) {
+          notifyMergeReadOnlyAction(translator);
+          return;
+        }
         // Otherwise merge with the next cell.
         const cellModel = cells.get(active + 1);
 
@@ -579,7 +627,7 @@ export namespace NotebookActions {
 
     const state = Private.getState(notebook);
 
-    Private.changeCellType(notebook, value, translator);
+    Private.changeCellType(notebook, value, { translator });
     void Private.handleState(notebook, state);
   }
 
@@ -1532,7 +1580,6 @@ export namespace NotebookActions {
     }
 
     const state = Private.getState(notebook);
-
     notebook.mode = 'command';
     notebook.model.sharedModel.undo();
     notebook.deselectAll();
@@ -1954,15 +2001,12 @@ export namespace NotebookActions {
     }
 
     const state = Private.getState(notebook);
-    const cells = notebook.model.cells;
 
     level = Math.min(Math.max(level, 1), 6);
-    notebook.widgets.forEach((child, index) => {
-      if (notebook.isSelectedOrActive(child)) {
-        Private.setMarkdownHeader(cells.get(index), level);
-      }
+    Private.changeCellType(notebook, 'markdown', {
+      translator,
+      headingLevel: level
     });
-    Private.changeCellType(notebook, 'markdown', translator);
     void Private.handleState(notebook, state);
   }
 
@@ -2257,12 +2301,12 @@ export namespace NotebookActions {
   export function trust(
     notebook: Notebook,
     translator?: ITranslator
-  ): Promise<void> {
+  ): Promise<{ trusted: boolean }> {
     translator = translator || nullTranslator;
     const trans = translator.load('jupyterlab');
 
     if (!notebook.model) {
-      return Promise.resolve();
+      return Promise.resolve({ trusted: false });
     }
     // Do nothing if already trusted.
 
@@ -2294,7 +2338,7 @@ export namespace NotebookActions {
       return showDialog({
         body: trans.__('Notebook is already trusted'),
         buttons: [Dialog.okButton()]
-      }).then(() => undefined);
+      }).then(() => ({ trusted: true }));
     }
 
     return showDialog({
@@ -2314,7 +2358,9 @@ export namespace NotebookActions {
             cell.trusted = true;
           }
         }
+        return { trusted: true };
       }
+      return { trusted: false };
     });
   }
 
@@ -2412,6 +2458,7 @@ namespace Private {
   /**
    * Notebook cell executor
    */
+  // eslint-disable-next-line no-unassigned-vars
   export let executor: INotebookCellExecutor;
 
   /**
@@ -2812,8 +2859,12 @@ namespace Private {
   export function changeCellType(
     notebook: Notebook,
     value: nbformat.CellType,
-    translator?: ITranslator
+    options?: {
+      translator?: ITranslator;
+      headingLevel?: number;
+    }
   ): void {
+    const { translator, headingLevel } = options ?? {};
     const notebookSharedModel = notebook.model!.sharedModel;
     notebook.widgets.forEach((child, index) => {
       if (!notebook.isSelectedOrActive(child)) {
@@ -2823,8 +2874,7 @@ namespace Private {
         child.model.type === 'code' &&
         (child as CodeCell).outputArea.pendingInput
       ) {
-        translator = translator || nullTranslator;
-        const trans = translator.load('jupyterlab');
+        const trans = (translator ?? nullTranslator).load('jupyterlab');
         // Do not permit changing cell type when input is pending
         void showDialog({
           title: trans.__('Cell type not changed due to pending input'),
@@ -2836,8 +2886,7 @@ namespace Private {
         return;
       }
       if (child.model.getMetadata('editable') == false) {
-        translator = translator || nullTranslator;
-        const trans = translator.load('jupyterlab');
+        const trans = (translator ?? nullTranslator).load('jupyterlab');
         // Do not permit changing cell type when the cell is readonly
         void showDialog({
           title: trans.__('Cell is read-only'),
@@ -2848,6 +2897,10 @@ namespace Private {
       }
       if (child.model.type !== value) {
         const raw = child.model.toJSON();
+        let newSource = raw.source as string;
+        if (headingLevel !== undefined) {
+          newSource = Private.setMarkdownHeader(newSource, headingLevel);
+        }
         notebookSharedModel.transact(() => {
           notebookSharedModel.deleteCell(index);
           if (value === 'code') {
@@ -2861,7 +2914,7 @@ namespace Private {
           const newCell = notebookSharedModel.insertCell(index, {
             id: raw.id,
             cell_type: value,
-            source: raw.source,
+            source: newSource,
             metadata: raw.metadata
           });
           if (raw.attachments && ['markdown', 'raw'].includes(value)) {
@@ -2869,6 +2922,15 @@ namespace Private {
               raw.attachments as nbformat.IAttachments;
           }
         });
+      } else if (value === 'markdown' && headingLevel !== undefined) {
+        notebookSharedModel.transact(() => {
+          child.model.sharedModel.setSource(
+            Private.setMarkdownHeader(
+              child.model.sharedModel.getSource(),
+              headingLevel
+            )
+          );
+        });
       }
       if (value === 'markdown') {
         // Fetch the new widget and unrender it.
@@ -2947,11 +3009,10 @@ namespace Private {
   }
 
   /**
-   * Set the markdown header level of a cell.
+   * Set the markdown header level of a cell source.
    */
-  export function setMarkdownHeader(cell: ICellModel, level: number): void {
+  export function setMarkdownHeader(source: string, level: number): string {
     // Remove existing header or leading white space.
-    let source = cell.sharedModel.getSource();
     const regex = /^(#+\s*)|^(\s*)/;
     const newHeader = Array(level + 1).join('#') + ' ';
     const matches = regex.exec(source);
@@ -2959,7 +3020,7 @@ namespace Private {
     if (matches) {
       source = source.slice(matches[0].length);
     }
-    cell.sharedModel.setSource(newHeader + source);
+    return newHeader + source;
   }
 
   /** Functionality related to collapsible headings */