@jupyter/collaboration-extension 1.0.0-alpha.0

package/README.md

@@ -0,0 +1,3 @@
+# @jupyter/collaboration-extension
+
+A JupyterLab package which provides a set of plugins for Real Time Collaboration.

package/lib/collaboration.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @packageDocumentation
+ * @module collaboration-extension
+ */
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { IAwareness, IUserMenu } from '@jupyter/collaboration';
+/**
+ * Jupyter plugin providing the IUserMenu.
+ */
+export declare const userMenuPlugin: JupyterFrontEndPlugin<IUserMenu>;
+/**
+ * Jupyter plugin adding the IUserMenu to the menu bar if collaborative flag enabled.
+ */
+export declare const menuBarPlugin: JupyterFrontEndPlugin<void>;
+/**
+ * Jupyter plugin creating a global awareness for RTC.
+ */
+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>;

package/lib/collaboration.js

@@ -0,0 +1,131 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module collaboration-extension
+ */
+import { PageConfig } from '@jupyterlab/coreutils';
+import { DOMUtils } from '@jupyterlab/apputils';
+import { AwarenessMock, CollaboratorsPanel, IGlobalAwareness, IUserMenu, 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 * as Y from 'yjs';
+import { Awareness } from 'y-protocols/awareness';
+import { WebsocketProvider } from 'y-websocket';
+/**
+ * Jupyter plugin providing the IUserMenu.
+ */
+export const userMenuPlugin = {
+    id: '@jupyter/collaboration-extension:userMenu',
+    autoStart: true,
+    requires: [],
+    provides: IUserMenu,
+    activate: (app) => {
+        const { commands } = app;
+        const { user } = app.serviceManager;
+        return new UserMenu({ commands, user });
+    }
+};
+/**
+ * Jupyter plugin adding the IUserMenu to the menu bar if collaborative flag enabled.
+ */
+export const menuBarPlugin = {
+    id: '@jupyter/collaboration-extension:userMenuBar',
+    autoStart: true,
+    requires: [IUserMenu],
+    activate: async (app, menu) => {
+        const { shell } = app;
+        const { user } = app.serviceManager;
+        if (PageConfig.getOption('collaborative') !== 'true') {
+            return;
+        }
+        const menuBar = new MenuBar({
+            forceItemsPosition: {
+                forceX: false,
+                forceY: false
+            },
+            renderer: new RendererUserMenu(user)
+        });
+        menuBar.id = 'jp-UserMenu';
+        user.userChanged.connect(() => menuBar.update());
+        menuBar.addMenu(menu);
+        shell.add(menuBar, 'top', { rank: 1000 });
+    }
+};
+/**
+ * Jupyter plugin creating a global awareness for RTC.
+ */
+export const rtcGlobalAwarenessPlugin = {
+    id: '@jupyter/collaboration-extension:rtcGlobalAwareness',
+    autoStart: true,
+    requires: [IStateDB],
+    provides: IGlobalAwareness,
+    activate: (app, state) => {
+        const { user } = app.serviceManager;
+        const ydoc = new Y.Doc();
+        if (PageConfig.getOption('collaborative') !== 'true') {
+            return new AwarenessMock(ydoc);
+        }
+        const awareness = new Awareness(ydoc);
+        const server = ServerConnection.makeSettings();
+        const url = URLExt.join(server.wsUrl, 'api/yjs');
+        new WebsocketProvider(url, 'JupyterLab:globalAwareness', ydoc, {
+            awareness: awareness
+        });
+        const userChanged = () => {
+            awareness.setLocalStateField('user', user.identity);
+        };
+        if (user.isReady) {
+            userChanged();
+        }
+        user.ready.then(userChanged).catch(e => console.error(e));
+        user.userChanged.connect(userChanged);
+        state.changed.connect(async () => {
+            var _a, _b;
+            const data = await state.toJSON();
+            const current = ((_b = (_a = data['layout-restorer:data']) === null || _a === void 0 ? void 0 : _a.main) === null || _b === void 0 ? void 0 : _b.current) || '';
+            if (current.startsWith('editor') || current.startsWith('notebook')) {
+                awareness.setLocalStateField('current', current);
+            }
+            else {
+                awareness.setLocalStateField('current', null);
+            }
+        });
+        return awareness;
+    }
+};
+/**
+ * Jupyter plugin adding the RTC information to the application left panel if collaborative flag enabled.
+ */
+export const rtcPanelPlugin = {
+    id: '@jupyter/collaboration-extension:rtcPanel',
+    autoStart: true,
+    requires: [IGlobalAwareness, ITranslator],
+    activate: (app, awareness, translator) => {
+        if (PageConfig.getOption('collaborative') !== 'true') {
+            return;
+        }
+        const { user } = app.serviceManager;
+        const trans = translator.load('jupyterlab');
+        const userPanel = new SidePanel();
+        userPanel.id = DOMUtils.createDomID();
+        userPanel.title.icon = usersIcon;
+        userPanel.title.caption = trans.__('Collaboration');
+        userPanel.addClass('jp-RTCPanel');
+        app.shell.add(userPanel, 'left', { rank: 300 });
+        const currentUserPanel = new UserInfoPanel(user);
+        currentUserPanel.title.label = trans.__('User info');
+        currentUserPanel.title.caption = trans.__('User information');
+        userPanel.addWidget(currentUserPanel);
+        const fileopener = (path) => {
+            void app.commands.execute('docmanager:open', { path });
+        };
+        const collaboratorsPanel = new CollaboratorsPanel(user, awareness, fileopener);
+        collaboratorsPanel.title.label = trans.__('Online Collaborators');
+        userPanel.addWidget(collaboratorsPanel);
+    }
+};

package/lib/filebrowser.d.ts

@@ -0,0 +1,6 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
+/**
+ * The default file browser factory provider.
+ */
+export declare const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser>;

package/lib/filebrowser.js

@@ -0,0 +1,79 @@
+import { ILabShell, IRouter, JupyterFrontEnd } from '@jupyterlab/application';
+import { IDefaultFileBrowser, IFileBrowserFactory } from '@jupyterlab/filebrowser';
+import { YDrive } from '@jupyter/docprovider';
+/**
+ * The command IDs used by the file browser plugin.
+ */
+var CommandIDs;
+(function (CommandIDs) {
+    CommandIDs.openPath = 'filebrowser:open-path';
+})(CommandIDs || (CommandIDs = {}));
+/**
+ * The default file browser factory provider.
+ */
+export const defaultFileBrowser = {
+    id: '@jupyter/collaboration-extension:defaultFileBrowser',
+    provides: IDefaultFileBrowser,
+    requires: [IFileBrowserFactory],
+    optional: [IRouter, JupyterFrontEnd.ITreeResolver, ILabShell],
+    activate: async (app, fileBrowserFactory, router, tree, labShell) => {
+        console.debug('@jupyter/collaboration-extension:defaultFileBrowser: activated');
+        const { commands } = app;
+        const drive = new YDrive(app.serviceManager.user);
+        app.serviceManager.contents.addDrive(drive);
+        // Manually restore and load the default file browser.
+        const defaultBrowser = fileBrowserFactory.createFileBrowser('filebrowser', {
+            auto: false,
+            restore: false,
+            driveName: 'YDrive'
+        });
+        void Private.restoreBrowser(defaultBrowser, commands, router, tree, labShell);
+        return defaultBrowser;
+    }
+};
+var Private;
+(function (Private) {
+    /**
+     * Restores file browser state and overrides state if tree resolver resolves.
+     */
+    async function restoreBrowser(browser, commands, router, tree, labShell) {
+        const restoring = 'jp-mod-restoring';
+        browser.addClass(restoring);
+        if (!router) {
+            await browser.model.restore(browser.id);
+            await browser.model.refresh();
+            browser.removeClass(restoring);
+            return;
+        }
+        const listener = async () => {
+            router.routed.disconnect(listener);
+            const paths = await (tree === null || tree === void 0 ? void 0 : tree.paths);
+            if ((paths === null || paths === void 0 ? void 0 : paths.file) || (paths === null || paths === void 0 ? void 0 : paths.browser)) {
+                // Restore the model without populating it.
+                await browser.model.restore(browser.id, false);
+                if (paths.file) {
+                    await commands.execute(CommandIDs.openPath, {
+                        path: paths.file,
+                        dontShowBrowser: true
+                    });
+                }
+                if (paths.browser) {
+                    await commands.execute(CommandIDs.openPath, {
+                        path: paths.browser,
+                        dontShowBrowser: true
+                    });
+                }
+            }
+            else {
+                await browser.model.restore(browser.id);
+                await browser.model.refresh();
+            }
+            browser.removeClass(restoring);
+            if (labShell === null || labShell === void 0 ? void 0 : labShell.isEmpty('main')) {
+                void commands.execute('launcher:create');
+            }
+        };
+        router.routed.connect(listener);
+    }
+    Private.restoreBrowser = restoreBrowser;
+})(Private || (Private = {}));

package/lib/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @packageDocumentation
+ * @module collaboration-extension
+ */
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+/**
+ * Export the plugins as default.
+ */
+declare const plugins: JupyterFrontEndPlugin<any>[];
+export default plugins;

package/lib/index.js

@@ -0,0 +1,19 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+/**
+ * @packageDocumentation
+ * @module collaboration-extension
+ */
+import { defaultFileBrowser } from './filebrowser';
+import { userMenuPlugin, menuBarPlugin, rtcGlobalAwarenessPlugin, rtcPanelPlugin } from './collaboration';
+/**
+ * Export the plugins as default.
+ */
+const plugins = [
+    defaultFileBrowser,
+    userMenuPlugin,
+    menuBarPlugin,
+    rtcGlobalAwarenessPlugin,
+    rtcPanelPlugin
+];
+export default plugins;

package/package.json

@@ -0,0 +1,105 @@
+{
+  "name": "@jupyter/collaboration-extension",
+  "version": "1.0.0-alpha.0",
+  "description": "JupyterLab - Real-Time Collaboration Extension",
+  "keywords": [
+    "jupyter",
+    "jupyterlab",
+    "jupyterlab-extension"
+  ],
+  "homepage": "https://github.com/jupyterlab/jupyter_collaboration",
+  "bugs": {
+    "url": "https://github.com/jupyterlab/jupyter_collaboration/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlab/jupyter_collaboration.git"
+  },
+  "license": "BSD-3-Clause",
+  "author": "Project Jupyter",
+  "sideEffects": [
+    "style/*.css",
+    "style/index.js"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "style": "style/index.css",
+  "styleModule": "style/index.js",
+  "directories": {
+    "lib": "lib/"
+  },
+  "files": [
+    "lib/*.d.ts",
+    "lib/*.js.map",
+    "lib/*.js",
+    "schema/*.json",
+    "style/*.css",
+    "style/index.js"
+  ],
+  "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:labextension": "jupyter labextension build .",
+    "build:labextension:dev": "jupyter labextension build --development True .",
+    "clean": "jlpm run clean:lib",
+    "clean:lib": "rimraf lib tsconfig.tsbuildinfo node_modules",
+    "clean:labextension": "rimraf ../../jupyter_collaboration/labextension",
+    "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
+    "install:extension": "jlpm run build",
+    "watch": "run-p watch:src watch:labextension",
+    "watch:src": "tsc -w",
+    "watch:labextension": "jupyter labextension watch ."
+  },
+  "dependencies": {
+    "@jupyter/collaboration": "^1.0.0-alpha.0",
+    "@jupyter/docprovider": "^1.0.0-alpha.0",
+    "@jupyterlab/application": "^4.0.0-alpha.18",
+    "@jupyterlab/apputils": "^4.0.0-alpha.18",
+    "@jupyterlab/coreutils": "^6.0.0-alpha.18",
+    "@jupyterlab/filebrowser": "^4.0.0-alpha.18",
+    "@jupyterlab/services": "^7.0.0-alpha.18",
+    "@jupyterlab/statedb": "^4.0.0-alpha.18",
+    "@jupyterlab/translation": "^4.0.0-alpha.18",
+    "@jupyterlab/ui-components": "^4.0.0-alpha.33",
+    "@lumino/commands": "^2.0.0-alpha.6",
+    "@lumino/widgets": "^2.0.0-alpha.6",
+    "y-protocols": "^1.0.5",
+    "y-websocket": "^1.3.15",
+    "yjs": "^13.5.40"
+  },
+  "devDependencies": {
+    "@jupyterlab/builder": "^4.0.0-alpha.18",
+    "@types/react": "^18.0.27",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "~3.0.0",
+    "typescript": "~4.7.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "displayName": "@jupyter/collaboration-extension",
+    "tsconfig": "./tsconfig.json"
+  },
+  "jupyterlab": {
+    "extension": true,
+    "schemaDir": "./schema",
+    "outputDir": "../../jupyter_collaboration/labextension",
+    "disabledExtensions": [
+      "@jupyterlab/filebrowser-extension:defaultFileBrowser"
+    ],
+    "sharedPackages": {
+      "@jupyter/collaboration": {
+        "bundled": true,
+        "singleton": true
+      },
+      "@jupyter/docprovider": {
+        "bundled": true,
+        "singleton": true
+      }
+    }
+  }
+}

package/schema/user-menu-bar.json

@@ -0,0 +1,15 @@
+{
+  "title": "User Menu Bar",
+  "description": "User Menu Bar settings.",
+  "jupyter.lab.toolbars": {
+    "TopBar": [
+      {
+        "name": "user-menu",
+        "rank": 100
+      }
+    ]
+  },
+  "properties": {},
+  "additionalProperties": false,
+  "type": "object"
+}

package/style/base.css

@@ -0,0 +1,4 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|---------------------------------------------------------------------------- */

package/style/index.css

@@ -0,0 +1,6 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|---------------------------------------------------------------------------- */
+
+@import url('./base.css');

package/style/index.js

@@ -0,0 +1,6 @@
+/*-----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+
+import './base.css';