@jupyter/docprovider-extension 4.3.0 → 4.4.0-alpha.0

package/lib/filebrowser.js

@@ -5,6 +5,7 @@
 import { Dialog, showDialog } from '@jupyterlab/apputils';
 import { Widget } from '@lumino/widgets';
 import { IStatusBar } from '@jupyterlab/statusbar';
+import { IDocumentManager } from '@jupyterlab/docmanager';
 import { IEditorTracker, IEditorWidgetFactory } from '@jupyterlab/fileeditor';
 import { ILoggerRegistry } from '@jupyterlab/logconsole';
 import { INotebookTracker, INotebookWidgetFactory } from '@jupyterlab/notebook';
@@ -12,7 +13,7 @@ import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { YFile, YNotebook } from '@jupyter/ydoc';
 import { ICollaborativeContentProvider, IGlobalAwareness } from '@jupyter/collaborative-drive';
-import { TimelineWidget, RtcContentProvider } from '@jupyter/docprovider';
+import { TimelineWidget, RtcContentProvider, IDocumentProviderFactory } from '@jupyter/docprovider';
 import { URLExt } from '@jupyterlab/coreutils';
 const DOCUMENT_TIMELINE_URL = 'api/collaboration/timeline';
 const TWO_SESSIONS_WARNING = 'The file %1 has been opened with two different views. ' +
@@ -22,9 +23,9 @@ export const rtcContentProvider = {
     id: '@jupyter/docprovider-extension:content-provider',
     description: 'The RTC content provider',
     provides: ICollaborativeContentProvider,
-    requires: [ITranslator],
-    optional: [IGlobalAwareness, ISettingRegistry],
-    activate: async (app, translator, globalAwareness, settingRegistry) => {
+    requires: [ITranslator, IDocumentProviderFactory],
+    optional: [IGlobalAwareness, IDocumentManager],
+    activate: (app, translator, providerFactory, globalAwareness, documentManager) => {
         const trans = translator.load('jupyter_collaboration');
         const defaultDrive = app.serviceManager.contents
             .defaultDrive;
@@ -35,17 +36,15 @@ export const rtcContentProvider = {
         if (!registry) {
             throw Error('Cannot initialize content provider: no content provider registry.');
         }
-        const docmanagerSettings = settingRegistry
-            ? await settingRegistry.load('@jupyterlab/docmanager-extension:plugin')
-            : null;
         const rtcContentProvider = new RtcContentProvider({
             currentDrive: defaultDrive,
             serverSettings: defaultDrive.serverSettings,
             user: app.serviceManager.user,
             trans,
             globalAwareness,
-            docmanagerSettings,
-            fileChanged: defaultDrive.fileChanged
+            documentManager,
+            fileChanged: defaultDrive.fileChanged,
+            providerFactory: providerFactory
         });
         registry.register('rtc', rtcContentProvider);
         return rtcContentProvider;
@@ -84,9 +83,8 @@ export const ynotebook = {
                 .load('@jupyterlab/notebook-extension:tracker')
                 .then(settings => {
                 const updateSettings = (settings) => {
-                    var _a;
                     const enableDocWideUndo = settings === null || settings === void 0 ? void 0 : settings.get('experimentalEnableDocumentWideUndoRedo').composite;
-                    disableDocumentWideUndoRedo = (_a = !enableDocWideUndo) !== null && _a !== void 0 ? _a : true;
+                    disableDocumentWideUndoRedo = !enableDocWideUndo;
                 };
                 updateSettings(settings);
                 settings.changed.connect((settings) => updateSettings(settings));

package/lib/index.js

@@ -7,6 +7,7 @@
 import { rtcContentProvider, yfile, ynotebook, logger, statusBarTimeline } from './filebrowser';
 import { notebookCellExecutor } from './executor';
 import { forkManagerPlugin } from './forkManager';
+import { documentProviderFactoryPlugin, awarenessProviderFactoryPlugin } from './yprovider';
 /**
  * Export the plugins as default.
  */
@@ -17,6 +18,8 @@ const plugins = [
     logger,
     notebookCellExecutor,
     statusBarTimeline,
-    forkManagerPlugin
+    forkManagerPlugin,
+    documentProviderFactoryPlugin,
+    awarenessProviderFactoryPlugin
 ];
 export default plugins;

package/lib/yprovider.d.ts

@@ -0,0 +1,10 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+import { IAwarenessProviderFactory, IDocumentProviderFactory } from '@jupyter/docprovider';
+/**
+ * Plugin that provides the WebSocket document provider factory.
+ */
+export declare const documentProviderFactoryPlugin: JupyterFrontEndPlugin<IDocumentProviderFactory>;
+/**
+ * Plugin that provides the WebSocket awareness provider factory.
+ */
+export declare const awarenessProviderFactoryPlugin: JupyterFrontEndPlugin<IAwarenessProviderFactory>;

package/lib/yprovider.js

@@ -0,0 +1,71 @@
+/* -----------------------------------------------------------------------------
+| Copyright (c) Jupyter Development Team.
+| Distributed under the terms of the Modified BSD License.
+|----------------------------------------------------------------------------*/
+import { ITranslator } from '@jupyterlab/translation';
+import { WebSocketProvider, WebSocketAwarenessProvider, IAwarenessProviderFactory, IDocumentProviderFactory } from '@jupyter/docprovider';
+import { URLExt } from '@jupyterlab/coreutils';
+/**
+ * The plugin ID for settings.
+ */
+const PLUGIN_ID = '@jupyter/docprovider-extension:websocket-provider';
+/**
+ * Document provider factory that creates WebSocket providers.
+ */
+class WebSocketDocumentProviderFactory {
+    constructor(_trans) {
+        this._trans = _trans;
+    }
+    create(options) {
+        return new WebSocketProvider({
+            path: options.path,
+            contentType: options.contentType,
+            format: options.format,
+            model: options.model,
+            user: options.user,
+            translator: this._trans,
+            serverSettings: options.serverSettings
+        });
+    }
+}
+/**
+ * Awareness provider factory that creates WebSocket awareness providers.
+ */
+class WebSocketAwarenessProviderFactory {
+    create(options) {
+        const url = URLExt.join(options.serverSettings.wsUrl, 'api/collaboration/room');
+        return new WebSocketAwarenessProvider({
+            url,
+            roomID: options.roomID,
+            awareness: options.awareness,
+            user: options.user
+        });
+    }
+}
+/**
+ * Plugin that provides the WebSocket document provider factory.
+ */
+export const documentProviderFactoryPlugin = {
+    id: PLUGIN_ID + '-document-factory',
+    description: 'Provides a WebSocket document provider factory.',
+    requires: [ITranslator],
+    optional: [],
+    provides: IDocumentProviderFactory,
+    activate: async (app, translator) => {
+        const trans = translator.load('jupyter_collaboration');
+        return new WebSocketDocumentProviderFactory(trans);
+    }
+};
+/**
+ * Plugin that provides the WebSocket awareness provider factory.
+ */
+export const awarenessProviderFactoryPlugin = {
+    id: PLUGIN_ID + '-awareness-factory',
+    description: 'Provides awareness provider factory.',
+    requires: [],
+    optional: [],
+    provides: IAwarenessProviderFactory,
+    activate: async (app) => {
+        return new WebSocketAwarenessProviderFactory();
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider-extension",
-  "version": "4.3.0",
+  "version": "4.4.0-alpha.0",
   "description": "JupyterLab - Collaborative Shared Models",
   "keywords": [
     "jupyter",
@@ -53,11 +53,12 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyter/collaborative-drive": "^4.3.0",
-    "@jupyter/docprovider": "^4.3.0",
+    "@jupyter/collaborative-drive": "^4.4.0-alpha.0",
+    "@jupyter/docprovider": "^4.4.0-alpha.0",
     "@jupyter/ydoc": "^2.1.3 || ^3.0.0",
     "@jupyterlab/application": "^4.5.0",
     "@jupyterlab/apputils": "^4.5.0",
+    "@jupyterlab/docmanager": "^4.5.0",
     "@jupyterlab/docregistry": "^4.5.0",
     "@jupyterlab/filebrowser": "^4.5.0",
     "@jupyterlab/fileeditor": "^4.5.0",
@@ -75,7 +76,7 @@
     "@types/react": "~18.3.1",
     "npm-run-all": "^4.1.5",
     "rimraf": "^4.1.2",
-    "typescript": "~5.1.6"
+    "typescript": "~5.9.3"
   },
   "publishConfig": {
     "access": "public"