@jupyterlab/notebook 4.0.0-alpha.8 → 4.0.0-beta.0

package/lib/actions.d.ts

@@ -1,4 +1,4 @@
-import { ISessionContext } from '@jupyterlab/apputils';
+import { ISessionContext, ISessionContextDialogs } from '@jupyterlab/apputils';
 import { Cell } from '@jupyterlab/cells';
 import * as nbformat from '@jupyterlab/nbformat';
 import { KernelMessage } from '@jupyterlab/services';
@@ -120,7 +120,7 @@ export declare namespace NotebookActions {
      */
     function deleteCells(notebook: Notebook): void;
     /**
-     * Insert a new code cell above the active cell.
+     * Insert a new code cell above the active cell or in index 0 if the notebook is empty.
      *
      * @param notebook - The target notebook widget.
      *
@@ -132,7 +132,7 @@ export declare namespace NotebookActions {
      */
     function insertAbove(notebook: Notebook): void;
     /**
-     * Insert a new code cell below the active cell.
+     * Insert a new code cell below the active cell or in index 0 if the notebook is empty.
      *
      * @param notebook - The target notebook widget.
      *
@@ -152,7 +152,7 @@ export declare namespace NotebookActions {
     /**
      * Move the selected cell(s) up.
      *
-     * @param widget - The target notebook widget.
+     * @param notebook - The target notebook widget.
      */
     function moveUp(notebook: Notebook): void;
     /**
@@ -173,8 +173,9 @@ export declare namespace NotebookActions {
      * Run the selected cell(s).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The last selected cell will be activated, but not scrolled into view.
@@ -182,13 +183,14 @@ export declare namespace NotebookActions {
      * An execution error will prevent the remaining code cells from executing.
      * All markdown cells will be rendered.
      */
-    function run(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function run(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run the selected cell(s) and advance to the next cell.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -198,13 +200,14 @@ export declare namespace NotebookActions {
      * If the last selected cell is the last cell, a new code cell
      * will be created in `'edit'` mode.  The new cell creation can be undone.
      */
-    function runAndAdvance(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAndAdvance(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run the selected cell(s) and insert a new code cell.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * An execution error will prevent the remaining code cells from executing.
@@ -214,13 +217,14 @@ export declare namespace NotebookActions {
      * The cell insert can be undone.
      * The new cell will be scrolled into view.
      */
-    function runAndInsert(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAndInsert(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run all of the cells in the notebook.
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -228,14 +232,15 @@ export declare namespace NotebookActions {
      * All markdown cells will be rendered.
      * The last cell in the notebook will be activated and scrolled into view.
      */
-    function runAll(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
-    function renderAllMarkdown(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAll(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
+    function renderAllMarkdown(notebook: Notebook): Promise<boolean>;
     /**
      * Run all of the cells before the currently active cell (exclusive).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -243,13 +248,14 @@ export declare namespace NotebookActions {
      * All markdown cells will be rendered.
      * The currently active cell will remain selected.
      */
-    function runAllAbove(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAllAbove(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Run all of the cells after the currently active cell (inclusive).
      *
      * @param notebook - The target notebook widget.
-     *
-     * @param sessionContext - The optional client session object.
+     * @param sessionContext - The client session object.
+     * @param sessionDialogs - The session dialogs.
+     * @param translator - The application translator.
      *
      * #### Notes
      * The existing selection will be cleared.
@@ -257,7 +263,7 @@ export declare namespace NotebookActions {
      * All markdown cells will be rendered.
      * The last cell in the notebook will be activated and scrolled into view.
      */
-    function runAllBelow(notebook: Notebook, sessionContext?: ISessionContext): Promise<boolean>;
+    function runAllBelow(notebook: Notebook, sessionContext?: ISessionContext, sessionDialogs?: ISessionContextDialogs, translator?: ITranslator): Promise<boolean>;
     /**
      * Replaces the selection in the active cell of the notebook.
      *
@@ -293,12 +299,12 @@ export declare namespace NotebookActions {
      *
      * @param notebook - The target notebook widget
      */
-    function insertSameLevelHeadingAbove(notebook: Notebook): void;
+    function insertSameLevelHeadingAbove(notebook: Notebook): Promise<void>;
     /** Insert new heading of same level at end of current section.
      *
      * @param notebook - The target notebook widget
      */
-    function insertSameLevelHeadingBelow(notebook: Notebook): void;
+    function insertSameLevelHeadingBelow(notebook: Notebook): Promise<void>;
     /**
      * Select the heading above the active cell or, if already at heading, collapse it.
      *
@@ -356,7 +362,7 @@ export declare namespace NotebookActions {
      */
     function deselectAll(notebook: Notebook): void;
     /**
-     * Copy the selected cell data to a clipboard.
+     * Copy the selected cell(s) data to a clipboard.
      *
      * @param notebook - The target notebook widget.
      */
@@ -376,24 +382,42 @@ export declare namespace NotebookActions {
      *
      * @param notebook - The target notebook widget.
      *
-     * @param mode - the mode of the paste operation: 'below' pastes cells
-     *   below the active cell, 'above' pastes cells above the active cell,
-     *   and 'replace' removes the currently selected cells and pastes cells
-     *   in their place.
+     * @param mode - the mode of adding cells:
+     *   'below' (default) adds cells below the active cell,
+     *   'belowSelected' adds cells below all selected cells,
+     *   'above' adds cells above the active cell, and
+     *   'replace' removes the currently selected cells and adds cells in their place.
+     *
+     * #### Notes
+     * The last pasted cell becomes the active cell.
+     * This is a no-op if there is no cell data on the clipboard.
+     * This action can be undone.
+     */
+    function paste(notebook: Notebook, mode?: 'below' | 'belowSelected' | 'above' | 'replace'): void;
+    /**
+     * Duplicate selected cells in the notebook without using the application clipboard.
+     *
+     * @param notebook - The target notebook widget.
+     *
+     * @param mode - the mode of adding cells:
+     *   'below' (default) adds cells below the active cell,
+     *   'belowSelected' adds cells below all selected cells,
+     *   'above' adds cells above the active cell, and
+     *   'replace' removes the currently selected cells and adds cells in their place.
      *
      * #### Notes
      * The last pasted cell becomes the active cell.
      * This is a no-op if there is no cell data on the clipboard.
      * This action can be undone.
      */
-    function paste(notebook: Notebook, mode?: 'below' | 'above' | 'replace'): void;
+    function duplicate(notebook: Notebook, mode?: 'below' | 'belowSelected' | 'above' | 'replace'): void;
     /**
      * Undo a cell action.
      *
      * @param notebook - The target notebook widget.
      *
      * #### Notes
-     * This is a no-op if if there are no cell actions to undo.
+     * This is a no-op if there are no cell actions to undo.
      */
     function undo(notebook: Notebook): void;
     /**