@jupyter/collaboration-extension 1.0.0-alpha.3 → 1.0.0-alpha.5

package/lib/collaboration.d.ts

@@ -20,3 +20,4 @@ export declare const rtcGlobalAwarenessPlugin: JupyterFrontEndPlugin<IAwareness>
  * Jupyter plugin adding the RTC information to the application left panel if collaborative flag enabled.
  */
 export declare const rtcPanelPlugin: JupyterFrontEndPlugin<void>;
+export declare const userEditorCursors: JupyterFrontEndPlugin<void>;

package/lib/collaboration.js

@@ -5,13 +5,14 @@
  * @module collaboration-extension
  */
 import { DOMUtils } from '@jupyterlab/apputils';
-import { CollaboratorsPanel, IGlobalAwareness, IUserMenu, RendererUserMenu, UserInfoPanel, UserMenu } from '@jupyter/collaboration';
+import { EditorExtensionRegistry, IEditorExtensionRegistry } from '@jupyterlab/codemirror';
+import { CollaboratorsPanel, IGlobalAwareness, IUserMenu, remoteUserCursors, RendererUserMenu, UserInfoPanel, UserMenu } from '@jupyter/collaboration';
 import { SidePanel, usersIcon } from '@jupyterlab/ui-components';
 import { MenuBar } from '@lumino/widgets';
 import { URLExt } from '@jupyterlab/coreutils';
 import { ServerConnection } from '@jupyterlab/services';
 import { IStateDB } from '@jupyterlab/statedb';
-import { ITranslator } from '@jupyterlab/translation';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import * as Y from 'yjs';
 import { Awareness } from 'y-protocols/awareness';
 import { WebsocketProvider } from 'y-websocket';
@@ -20,7 +21,7 @@ import { WebsocketProvider } from 'y-websocket';
  */
 export const userMenuPlugin = {
     id: '@jupyter/collaboration-extension:userMenu',
-    autoStart: true,
+    description: 'Provide connected user menu.',
     requires: [],
     provides: IUserMenu,
     activate: (app) => {
@@ -34,6 +35,7 @@ export const userMenuPlugin = {
  */
 export const menuBarPlugin = {
     id: '@jupyter/collaboration-extension:userMenuBar',
+    description: 'Add user menu to the interface.',
     autoStart: true,
     requires: [IUserMenu],
     activate: async (app, menu) => {
@@ -57,7 +59,7 @@ export const menuBarPlugin = {
  */
 export const rtcGlobalAwarenessPlugin = {
     id: '@jupyter/collaboration-extension:rtcGlobalAwareness',
-    autoStart: true,
+    description: 'Add global awareness to share working document of users.',
     requires: [IStateDB],
     provides: IGlobalAwareness,
     activate: (app, state) => {
@@ -65,7 +67,7 @@ export const rtcGlobalAwarenessPlugin = {
         const ydoc = new Y.Doc();
         const awareness = new Awareness(ydoc);
         const server = ServerConnection.makeSettings();
-        const url = URLExt.join(server.wsUrl, 'api/yjs');
+        const url = URLExt.join(server.wsUrl, 'api/collaboration/room');
         new WebsocketProvider(url, 'JupyterLab:globalAwareness', ydoc, {
             awareness: awareness
         });
@@ -96,11 +98,13 @@ export const rtcGlobalAwarenessPlugin = {
  */
 export const rtcPanelPlugin = {
     id: '@jupyter/collaboration-extension:rtcPanel',
+    description: 'Add side panel to display all currently connected users.',
     autoStart: true,
-    requires: [IGlobalAwareness, ITranslator],
+    requires: [IGlobalAwareness],
+    optional: [ITranslator],
     activate: (app, awareness, translator) => {
         const { user } = app.serviceManager;
-        const trans = translator.load('jupyter_collaboration');
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyter_collaboration');
         const userPanel = new SidePanel();
         userPanel.id = DOMUtils.createDomID();
         userPanel.title.icon = usersIcon;
@@ -119,3 +123,18 @@ export const rtcPanelPlugin = {
         userPanel.addWidget(collaboratorsPanel);
     }
 };
+export const userEditorCursors = {
+    id: '@jupyter/collaboration-extension:userEditorCursors',
+    description: 'Add CodeMirror extension to display remote user cursors and selections.',
+    autoStart: true,
+    requires: [IEditorExtensionRegistry],
+    activate: (app, extensions) => {
+        extensions.addExtension({
+            name: 'remote-user-cursors',
+            factory(options) {
+                const { awareness, ysource: ytext } = options.model.sharedModel;
+                return EditorExtensionRegistry.createImmutableExtension(remoteUserCursors({ awareness, ytext }));
+            }
+        });
+    }
+};

package/lib/filebrowser.js

@@ -24,7 +24,6 @@ export const defaultFileBrowser = {
         ISettingRegistry
     ],
     activate: async (app, fileBrowserFactory, translator, router, tree, labShell, settingRegistry) => {
-        console.debug('@jupyter/collaboration-extension:defaultFileBrowser: activated');
         const { commands } = app;
         const trans = translator.load('jupyter_collaboration');
         const drive = new YDrive(app.serviceManager.user, trans);

package/lib/index.js

@@ -5,7 +5,7 @@
  * @module collaboration-extension
  */
 import { defaultFileBrowser } from './filebrowser';
-import { userMenuPlugin, menuBarPlugin, rtcGlobalAwarenessPlugin, rtcPanelPlugin } from './collaboration';
+import { userMenuPlugin, menuBarPlugin, rtcGlobalAwarenessPlugin, rtcPanelPlugin, userEditorCursors } from './collaboration';
 /**
  * Export the plugins as default.
  */
@@ -14,6 +14,7 @@ const plugins = [
     userMenuPlugin,
     menuBarPlugin,
     rtcGlobalAwarenessPlugin,
-    rtcPanelPlugin
+    rtcPanelPlugin,
+    userEditorCursors
 ];
 export default plugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/collaboration-extension",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.5",
   "description": "JupyterLab - Real-Time Collaboration Extension",
   "keywords": [
     "jupyter",
@@ -38,8 +38,9 @@
   ],
   "scripts": {
     "build": "jlpm run build:lib && jlpm run build:labextension:dev",
-    "build:lib": "tsc",
-    "build:prod": "jlpm run clean && jlpm run build:lib && jlpm run build:labextension",
+    "build:lib": "tsc --sourceMap",
+    "build:lib:prod": "tsc",
+    "build:prod": "jlpm run clean && jlpm run build:lib:prod && jlpm run build:labextension",
     "build:labextension": "jupyter labextension build .",
     "build:labextension:dev": "jupyter labextension build --development True .",
     "clean": "jlpm run clean:lib",
@@ -52,29 +53,30 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyter/collaboration": "^1.0.0-alpha.3",
-    "@jupyter/docprovider": "^1.0.0-alpha.3",
-    "@jupyterlab/application": "^4.0.0-alpha.19",
-    "@jupyterlab/apputils": "^4.0.0-alpha.19",
-    "@jupyterlab/coreutils": "^6.0.0-alpha.19",
-    "@jupyterlab/filebrowser": "^4.0.0-alpha.19",
-    "@jupyterlab/services": "^7.0.0-alpha.19",
-    "@jupyterlab/settingregistry": "^4.0.0-alpha.19",
-    "@jupyterlab/statedb": "^4.0.0-alpha.19",
-    "@jupyterlab/translation": "^4.0.0-alpha.19",
-    "@jupyterlab/ui-components": "^4.0.0-alpha.34",
-    "@lumino/commands": "^2.0.0-beta.1",
-    "@lumino/widgets": "^2.0.0-beta.1",
+    "@jupyter/collaboration": "^1.0.0-alpha.5",
+    "@jupyter/docprovider": "^1.0.0-alpha.5",
+    "@jupyterlab/application": "^4.0.0-alpha.22",
+    "@jupyterlab/apputils": "^4.0.0-alpha.22",
+    "@jupyterlab/codemirror": "^4.0.0-alpha.22",
+    "@jupyterlab/coreutils": "^6.0.0-alpha.22",
+    "@jupyterlab/filebrowser": "^4.0.0-alpha.22",
+    "@jupyterlab/services": "^7.0.0-alpha.22",
+    "@jupyterlab/settingregistry": "^4.0.0-alpha.22",
+    "@jupyterlab/statedb": "^4.0.0-alpha.22",
+    "@jupyterlab/translation": "^4.0.0-alpha.22",
+    "@jupyterlab/ui-components": "^4.0.0-alpha.37",
+    "@lumino/commands": "^2.0.0",
+    "@lumino/widgets": "^2.0.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "^4.0.0-alpha.19",
+    "@jupyterlab/builder": "^4.0.0-alpha.22",
     "@types/react": "^18.0.27",
     "npm-run-all": "^4.1.5",
     "rimraf": "^4.1.2",
-    "typescript": "~4.7.3"
+    "typescript": "~5.0.2"
   },
   "publishConfig": {
     "access": "public"
@@ -93,6 +95,14 @@
       "@jupyterlab/filebrowser-extension:defaultFileBrowser"
     ],
     "sharedPackages": {
+      "@codemirror/state": {
+        "bundled": false,
+        "singleton": true
+      },
+      "@codemirror/view": {
+        "bundled": false,
+        "singleton": true
+      },
       "@jupyter/collaboration": {
         "bundled": true,
         "singleton": true
@@ -104,6 +114,14 @@
       "@jupyter/ydoc": {
         "bundled": false,
         "singleton": true
+      },
+      "y-protocols": {
+        "bundled": false,
+        "singleton": true
+      },
+      "yjs": {
+        "bundled": false,
+        "singleton": true
       }
     }
   }