Support suggestions

Author: davidbrochart

package.json

@@ -65,5 +65,9 @@
     "stylelint-prettier": "^3.0.0",
     "typedoc": "~0.23.28",
     "typescript": "~5.0.4"
+  },
+  "resolutions": {
+    "@jupyter/ydoc": "file:.yalc/@jupyter/ydoc",
+    "@jupyterlab/services": "file:.yalc/@jupyterlab/services"
   }
 }

packages/collaboration-extension/package.json

@@ -55,7 +55,7 @@
   "dependencies": {
     "@jupyter/collaboration": "^2.0.2",
     "@jupyter/docprovider": "^2.0.2",
-    "@jupyter/ydoc": "^1.1.0-a0",
+    "@jupyter/ydoc": "file:.yalc/@jupyter/ydoc",
     "@jupyterlab/application": "^4.0.5",
     "@jupyterlab/apputils": "^4.0.5",
     "@jupyterlab/codemirror": "^4.0.5",

packages/collaboration-extension/src/collaboration.ts

@@ -5,6 +5,20 @@
  * @module collaboration-extension
  */
 
+import {
+  DocumentRegistry
+} from '@jupyterlab/docregistry';
+
+import {
+  NotebookPanel, INotebookModel
+} from '@jupyterlab/notebook';
+
+import {
+  IDisposable, DisposableDelegate
+} from '@lumino/disposable';
+
+import { CommandRegistry } from '@lumino/commands';
+
 import {
   JupyterFrontEnd,
   JupyterFrontEndPlugin
@@ -15,7 +29,11 @@ import {
   IEditorExtensionRegistry
 } from '@jupyterlab/codemirror';
 import { WebSocketAwarenessProvider } from '@jupyter/docprovider';
-import { SidePanel, usersIcon } from '@jupyterlab/ui-components';
+import {
+  SidePanel,
+  usersIcon,
+  caretDownIcon
+} from '@jupyterlab/ui-components';
 import { URLExt } from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import { IStateDB, StateDB } from '@jupyterlab/statedb';
@@ -189,3 +207,61 @@ export const userEditorCursors: JupyterFrontEndPlugin<void> = {
     });
   }
 };
+
+/**
+ * A plugin to add editing mode to the notebook page
+ */
+export const editingMode: JupyterFrontEndPlugin<void> = {
+  id: '@jupyter/collaboration-extension:editingMode',
+  description: 'A plugin to add editing mode to the notebook page.',
+  autoStart: true,
+  requires: [ITranslator],
+  activate: (
+    app: JupyterFrontEnd,
+  ) => {
+    app.docRegistry.addWidgetExtension('Notebook', new EditingModeExtension());
+  },
+};
+
+export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<NotebookPanel, INotebookModel> {
+  createNew(panel: NotebookPanel, context: DocumentRegistry.IContext<INotebookModel>): IDisposable {
+    const menubar = new MenuBar();
+    const commands = new CommandRegistry();
+    const menu = new Menu({ commands });
+    menu.title.label = 'Editing';
+    menu.title.icon = caretDownIcon;
+    addMenuItem(commands, menu, 'editing', 'Editing', context);
+    addMenuItem(commands, menu, 'suggesting', 'Suggesting', context);
+    menubar.addMenu(menu);
+
+    panel.toolbar.insertItem(990, 'editingMode', menubar);
+    return new DisposableDelegate(() => {
+      menubar.dispose();
+    });
+  }
+}
+
+/**
+ * Helper Function to add menu items.
+ */
+function addMenuItem(
+  commands: CommandRegistry,
+  menu: Menu,
+  command: string,
+  label: string,
+  context: DocumentRegistry.IContext<INotebookModel>,
+): void {
+  commands.addCommand(command, {
+    label: label,
+    execute: () => {
+      menu.title.label = label;
+      if (command == 'suggesting') {
+        context.model.sharedModel.getProvider('root').fork();
+      }
+    }
+  });
+  menu.addItem({
+    type: 'command',
+    command: command
+  });
+}

packages/collaboration-extension/src/index.ts

@@ -19,7 +19,8 @@ import {
   menuBarPlugin,
   rtcGlobalAwarenessPlugin,
   rtcPanelPlugin,
-  userEditorCursors
+  userEditorCursors,
+  editingMode
 } from './collaboration';
 import { sharedLink } from './sharedlink';
 
@@ -37,7 +38,8 @@ const plugins: JupyterFrontEndPlugin<any>[] = [
   rtcGlobalAwarenessPlugin,
   rtcPanelPlugin,
   sharedLink,
-  userEditorCursors
+  userEditorCursors,
+  editingMode
 ];
 
 export default plugins;

packages/collaboration/package.json

@@ -42,6 +42,7 @@
     "@codemirror/state": "^6.2.0",
     "@codemirror/view": "^6.7.0",
     "@jupyter/docprovider": "^2.0.2",
+    "@jupyter/ydoc": "file:.yalc/@jupyter/ydoc",
     "@jupyterlab/apputils": "^4.0.5",
     "@jupyterlab/coreutils": "^6.0.5",
     "@jupyterlab/services": "^7.0.5",

packages/collaboration/style/base.css

@@ -9,3 +9,22 @@
 .jp-shared-link-body {
     user-select: none;
 }
+
+.jp-EditingMode {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+}
+
+.jp-EditingMode .lm-MenuBar-itemIcon svg {
+  vertical-align: sub;
+}
+
+.jp-nb-editing-mode-button > .jp-ToolbarButtonComponent::part(content) {
+  flex-direction: row-reverse;
+}
+
+.jp-nb-editing-mode-button > .jp-ToolbarButtonComponent > svg {
+  padding-left: 3px;
+}

packages/docprovider/package.json

@@ -41,7 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^1.1.0-a0",
+    "@jupyter/ydoc": "file:.yalc/@jupyter/ydoc",
     "@jupyterlab/coreutils": "^6.0.5",
     "@jupyterlab/services": "^7.0.5",
     "@lumino/coreutils": "^2.1.0",
@@ -51,6 +51,10 @@
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
+  "resolutions": {
+    "@jupyterlab/services": "file:.yalc/@jupyterlab/services",
+    "@jupyter/ydoc": "file:.yalc/@jupyter/ydoc"
+  },
   "devDependencies": {
     "@jupyterlab/testing": "^4.0.5",
     "@types/jest": "^29.2.0",

packages/docprovider/src/index.ts

@@ -8,6 +8,7 @@
  */
 
 export * from './awareness';
+export * from './requests';
 export * from './ydrive';
 export * from './yprovider';
 export * from './tokens';

packages/docprovider/src/requests.ts

@@ -11,6 +11,7 @@ import { ServerConnection, Contents } from '@jupyterlab/services';
  * See https://github.com/jupyterlab/jupyter_collaboration
  */
 const DOC_SESSION_URL = 'api/collaboration/session';
+const DOC_FORK_URL = 'api/collaboration/fork_room';
 
 /**
  * Document session model
@@ -73,3 +74,42 @@ export async function requestDocSession(
 
   return data;
 }
+
+
+export async function requestDocFork(
+  roomid: string,
+): Promise<any> {
+  const settings = ServerConnection.makeSettings();
+  const url = URLExt.join(
+    settings.baseUrl,
+    DOC_FORK_URL,
+    encodeURIComponent(roomid)
+  );
+  const body = {
+    method: 'PUT',
+    body: JSON.stringify({ roomid })
+  };
+
+  let response: Response;
+  try {
+    response = await ServerConnection.makeRequest(url, body, settings);
+  } catch (error) {
+    throw new ServerConnection.NetworkError(error as Error);
+  }
+
+  let data: any = await response.text();
+
+  if (data.length > 0) {
+    try {
+      data = JSON.parse(data);
+    } catch (error) {
+      console.log('Not a JSON response body.', response);
+    }
+  }
+
+  if (!response.ok) {
+    throw new ServerConnection.ResponseError(response, data.message || data);
+  }
+
+  return data;
+}

packages/docprovider/src/ydrive.ts

@@ -147,6 +147,7 @@ export class YDrive extends Drive implements ICollaborativeDrive {
       const key = `${options.format}:${options.contentType}:${options.path}`;
       this._providers.set(key, provider);
 
+      sharedModel.setProvider('root', provider);
       sharedModel.disposed.connect(() => {
         const provider = this._providers.get(key);
         if (provider) {