@jupyter/collaboration-extension 1.0.0-alpha.7 → 1.0.0-alpha.9

package/lib/collaboration.js

@@ -4,7 +4,7 @@
  * @packageDocumentation
  * @module collaboration-extension
  */
-import { DOMUtils } from '@jupyterlab/apputils';
+import { DOMUtils, IToolbarWidgetRegistry } from '@jupyterlab/apputils';
 import { EditorExtensionRegistry, IEditorExtensionRegistry } from '@jupyterlab/codemirror';
 import { CollaboratorsPanel, IGlobalAwareness, IUserMenu, remoteUserCursors, RendererUserMenu, UserInfoPanel, UserMenu } from '@jupyter/collaboration';
 import { SidePanel, usersIcon } from '@jupyterlab/ui-components';
@@ -34,12 +34,11 @@ export const userMenuPlugin = {
  * Jupyter plugin adding the IUserMenu to the menu bar if collaborative flag enabled.
  */
 export const menuBarPlugin = {
-    id: '@jupyter/collaboration-extension:userMenuBar',
+    id: '@jupyter/collaboration-extension:user-menu-bar',
     description: 'Add user menu to the interface.',
     autoStart: true,
-    requires: [IUserMenu],
-    activate: async (app, menu) => {
-        const { shell } = app;
+    requires: [IUserMenu, IToolbarWidgetRegistry],
+    activate: async (app, menu, toolbarRegistry) => {
         const { user } = app.serviceManager;
         const menuBar = new MenuBar({
             forceItemsPosition: {
@@ -51,7 +50,7 @@ export const menuBarPlugin = {
         menuBar.id = 'jp-UserMenu';
         user.userChanged.connect(() => menuBar.update());
         menuBar.addMenu(menu);
-        shell.add(menuBar, 'top', { rank: 1000 });
+        toolbarRegistry.addFactory('TopBar', 'user-menu', () => menuBar);
     }
 };
 /**

package/lib/filebrowser.d.ts

@@ -2,18 +2,22 @@ import { JupyterFrontEndPlugin } from '@jupyterlab/application';
 import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
 import { ICollaborativeDrive } from '@jupyter/docprovider';
 /**
- * The default file browser factory provider.
+ * The default collaborative drive provider.
  */
 export declare const drive: JupyterFrontEndPlugin<ICollaborativeDrive>;
 /**
- * The default file browser factory provider.
+ * Plugin to register the shared model factory for the content type 'file'.
  */
 export declare const yfile: JupyterFrontEndPlugin<void>;
 /**
- * The default file browser factory provider.
+ * Plugin to register the shared model factory for the content type 'notebook'.
  */
 export declare const ynotebook: JupyterFrontEndPlugin<void>;
 /**
  * The default file browser factory provider.
  */
 export declare const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser>;
+/**
+ * The default collaborative drive provider.
+ */
+export declare const logger: JupyterFrontEndPlugin<void>;

package/lib/filebrowser.js

@@ -1,7 +1,15 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
 import { ILabShell, IRouter, JupyterFrontEnd } from '@jupyterlab/application';
+import { Dialog, showDialog } from '@jupyterlab/apputils';
 import { IDefaultFileBrowser, IFileBrowserFactory } from '@jupyterlab/filebrowser';
-import { ITranslator } from '@jupyterlab/translation';
+import { IEditorTracker } from '@jupyterlab/fileeditor';
+import { ILoggerRegistry } from '@jupyterlab/logconsole';
+import { INotebookTracker } from '@jupyterlab/notebook';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { YFile, YNotebook } from '@jupyter/ydoc';
 import { ICollaborativeDrive, YDrive } from '@jupyter/docprovider';
 /**
@@ -12,10 +20,11 @@ var CommandIDs;
     CommandIDs.openPath = 'filebrowser:open-path';
 })(CommandIDs || (CommandIDs = {}));
 /**
- * The default file browser factory provider.
+ * The default collaborative drive provider.
  */
 export const drive = {
     id: '@jupyter/collaboration-extension:drive',
+    description: 'The default collaborative drive provider',
     provides: ICollaborativeDrive,
     requires: [ITranslator],
     optional: [],
@@ -27,10 +36,11 @@ export const drive = {
     }
 };
 /**
- * The default file browser factory provider.
+ * Plugin to register the shared model factory for the content type 'file'.
  */
 export const yfile = {
     id: '@jupyter/collaboration-extension:yfile',
+    description: "Plugin to register the shared model factory for the content type 'file'",
     autoStart: true,
     requires: [ICollaborativeDrive],
     optional: [],
@@ -42,10 +52,11 @@ export const yfile = {
     }
 };
 /**
- * The default file browser factory provider.
+ * Plugin to register the shared model factory for the content type 'notebook'.
  */
 export const ynotebook = {
     id: '@jupyter/collaboration-extension:ynotebook',
+    description: "Plugin to register the shared model factory for the content type 'notebook'",
     autoStart: true,
     requires: [ICollaborativeDrive],
     optional: [ISettingRegistry],
@@ -78,6 +89,7 @@ export const ynotebook = {
  */
 export const defaultFileBrowser = {
     id: '@jupyter/collaboration-extension:defaultFileBrowser',
+    description: 'The default file browser factory provider',
     provides: IDefaultFileBrowser,
     requires: [ICollaborativeDrive, IFileBrowserFactory],
     optional: [
@@ -99,6 +111,72 @@ export const defaultFileBrowser = {
         return defaultBrowser;
     }
 };
+/**
+ * The default collaborative drive provider.
+ */
+export const logger = {
+    id: '@jupyter/collaboration-extension:logger',
+    description: 'A logging plugin for debugging purposes.',
+    autoStart: true,
+    optional: [ILoggerRegistry, IEditorTracker, INotebookTracker, ITranslator],
+    activate: (app, loggerRegistry, fileTracker, nbTracker, translator) => {
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyter_collaboration');
+        const schemaID = 'https://schema.jupyter.org/jupyter_collaboration/session/v1';
+        if (!loggerRegistry) {
+            app.serviceManager.events.stream.connect((_, emission) => {
+                var _a, _b;
+                if (emission.schema_id === schemaID) {
+                    console.debug(`[${emission.room}(${emission.path})] ${(_a = emission.action) !== null && _a !== void 0 ? _a : ''}: ${(_b = emission.msg) !== null && _b !== void 0 ? _b : ''}`);
+                    if (emission.level === 'WARNING') {
+                        showDialog({
+                            title: trans.__('Warning'),
+                            body: trans.__(`Two collaborative sessions are accessing the file ${emission.path} simultaneously.
+                \nOpening the same file using different views simultaneously is not supported. Please, close one view; otherwise, you might lose some of your progress.`),
+                            buttons: [Dialog.okButton()]
+                        });
+                    }
+                }
+            });
+            return;
+        }
+        const loggers = new Map();
+        const addLogger = (sender, document) => {
+            const logger = loggerRegistry.getLogger(document.context.path);
+            loggers.set(document.context.localPath, logger);
+            document.disposed.connect(document => {
+                loggers.delete(document.context.localPath);
+            });
+        };
+        if (fileTracker) {
+            fileTracker.widgetAdded.connect(addLogger);
+        }
+        if (nbTracker) {
+            nbTracker.widgetAdded.connect(addLogger);
+        }
+        void (async () => {
+            var _a, _b;
+            const { events } = app.serviceManager;
+            for await (const emission of events.stream) {
+                if (emission.schema_id === schemaID) {
+                    const logger = loggers.get(emission.path);
+                    logger === null || logger === void 0 ? void 0 : logger.log({
+                        type: 'text',
+                        level: emission.level.toLowerCase(),
+                        data: `[${emission.room}] ${(_a = emission.action) !== null && _a !== void 0 ? _a : ''}: ${(_b = emission.msg) !== null && _b !== void 0 ? _b : ''}`
+                    });
+                    if (emission.level === 'WARNING') {
+                        showDialog({
+                            title: trans.__('Warning'),
+                            body: trans.__(`Two collaborative sessions are accessing the file %1 simultaneously.
+                \n'Opening a document with multiple views simultaneously is not supported. Please close one view; otherwise, you might lose some of your progress.`, emission.path),
+                            buttons: [Dialog.warnButton({ label: trans.__('Ok') })]
+                        });
+                    }
+                }
+            }
+        })();
+    }
+};
 var Private;
 (function (Private) {
     /**

package/lib/index.js

@@ -4,8 +4,9 @@
  * @packageDocumentation
  * @module collaboration-extension
  */
-import { drive, yfile, ynotebook, defaultFileBrowser } from './filebrowser';
+import { drive, yfile, ynotebook, defaultFileBrowser, logger } from './filebrowser';
 import { userMenuPlugin, menuBarPlugin, rtcGlobalAwarenessPlugin, rtcPanelPlugin, userEditorCursors } from './collaboration';
+import { sharedLink } from './sharedlink';
 /**
  * Export the plugins as default.
  */
@@ -14,10 +15,12 @@ const plugins = [
     yfile,
     ynotebook,
     defaultFileBrowser,
+    logger,
     userMenuPlugin,
     menuBarPlugin,
     rtcGlobalAwarenessPlugin,
     rtcPanelPlugin,
+    sharedLink,
     userEditorCursors
 ];
 export default plugins;

package/lib/sharedlink.d.ts

@@ -0,0 +1,5 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+/**
+ * Plugin to share the URL of the running Jupyter Server
+ */
+export declare const sharedLink: JupyterFrontEndPlugin<void>;

package/lib/sharedlink.js

@@ -0,0 +1,43 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { Clipboard, ICommandPalette } from '@jupyterlab/apputils';
+import { ITranslator, nullTranslator } from '@jupyterlab/translation';
+import { shareIcon } from '@jupyterlab/ui-components';
+import { showSharedLinkDialog } from '@jupyter/collaboration';
+/**
+ * The command IDs used by the plugin.
+ */
+var CommandIDs;
+(function (CommandIDs) {
+    CommandIDs.share = 'collaboration:shared-link';
+})(CommandIDs || (CommandIDs = {}));
+/**
+ * Plugin to share the URL of the running Jupyter Server
+ */
+export const sharedLink = {
+    id: '@jupyter/collaboration-extension:shared-link',
+    autoStart: true,
+    optional: [ICommandPalette, ITranslator],
+    activate: async (app, palette, translator) => {
+        const { commands } = app;
+        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('collaboration');
+        commands.addCommand(CommandIDs.share, {
+            label: trans.__('Generate a Shared Link'),
+            icon: shareIcon,
+            execute: async () => {
+                const result = await showSharedLinkDialog({
+                    translator
+                });
+                if (result.button.accept && result.value) {
+                    Clipboard.copyToSystem(result.value);
+                }
+            }
+        });
+        if (palette) {
+            palette.addItem({
+                command: CommandIDs.share,
+                category: trans.__('Server')
+            });
+        }
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/collaboration-extension",
-  "version": "1.0.0-alpha.7",
+  "version": "1.0.0-alpha.9",
   "description": "JupyterLab - Real-Time Collaboration Extension",
   "keywords": [
     "jupyter",
@@ -53,30 +53,34 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyter/collaboration": "^1.0.0-alpha.7",
-    "@jupyter/docprovider": "^1.0.0-alpha.7",
-    "@jupyterlab/application": "^4.0.0-beta.0",
-    "@jupyterlab/apputils": "^4.0.0-beta.0",
-    "@jupyterlab/codemirror": "^4.0.0-beta.0",
-    "@jupyterlab/coreutils": "^6.0.0-beta.0",
-    "@jupyterlab/filebrowser": "^4.0.0-beta.0",
-    "@jupyterlab/services": "^7.0.0-beta.0",
-    "@jupyterlab/settingregistry": "^4.0.0-beta.0",
-    "@jupyterlab/statedb": "^4.0.0-beta.0",
-    "@jupyterlab/translation": "^4.0.0-beta.0",
-    "@jupyterlab/ui-components": "^4.0.0-beta.0",
-    "@lumino/commands": "^2.0.0",
-    "@lumino/widgets": "^2.0.0",
+    "@jupyter/collaboration": "^1.0.0-alpha.9",
+    "@jupyter/docprovider": "^1.0.0-alpha.9",
+    "@jupyterlab/application": "^4.0.0",
+    "@jupyterlab/apputils": "^4.0.0",
+    "@jupyterlab/codemirror": "^4.0.0",
+    "@jupyterlab/coreutils": "^6.0.0",
+    "@jupyterlab/docregistry": "^4.0.0",
+    "@jupyterlab/filebrowser": "^4.0.0",
+    "@jupyterlab/fileeditor": "^4.0.0",
+    "@jupyterlab/logconsole": "^4.0.0",
+    "@jupyterlab/notebook": "^4.0.0",
+    "@jupyterlab/services": "^7.0.0",
+    "@jupyterlab/settingregistry": "^4.0.0",
+    "@jupyterlab/statedb": "^4.0.0",
+    "@jupyterlab/translation": "^4.0.0",
+    "@jupyterlab/ui-components": "^4.0.0",
+    "@lumino/commands": "^2.1.0",
+    "@lumino/widgets": "^2.1.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "^4.0.0-beta.0",
-    "@types/react": "^18.0.27",
+    "@jupyterlab/builder": "^4.0.0",
+    "@types/react": "~18.0.26",
     "npm-run-all": "^4.1.5",
     "rimraf": "^4.1.2",
-    "typescript": "~5.0.2"
+    "typescript": "~5.0.4"
   },
   "publishConfig": {
     "access": "public"

package/schema/shared-link.json

@@ -0,0 +1,16 @@
+{
+  "title": "Shared link",
+  "description": "Shared link settings",
+  "jupyter.lab.toolbars": {
+    "TopBar": [
+      {
+        "name": "@jupyter/collaboration:shared-link",
+        "command": "collaboration:shared-link",
+        "rank": 99
+      }
+    ]
+  },
+  "properties": {},
+  "additionalProperties": false,
+  "type": "object"
+}