@jupyter/docprovider-extension 3.1.0-rc.0 → 4.0.0-alpha.0

package/lib/filebrowser.d.ts

@@ -1,10 +1,6 @@
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
-import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
-import { ICollaborativeDrive } from '@jupyter/collaborative-drive';
-/**
- * The default collaborative drive provider.
- */
-export declare const drive: JupyterFrontEndPlugin<ICollaborativeDrive>;
+import { ICollaborativeContentProvider } from '@jupyter/collaborative-drive';
+export declare const rtcContentProvider: JupyterFrontEndPlugin<ICollaborativeContentProvider>;
 /**
  * Plugin to register the shared model factory for the content type 'file'.
  */
@@ -17,10 +13,6 @@ export declare const ynotebook: JupyterFrontEndPlugin<void>;
  * A plugin to add a timeline slider status item to the status bar.
  */
 export declare const statusBarTimeline: JupyterFrontEndPlugin<void>;
-/**
- * The default file browser factory provider.
- */
-export declare const defaultFileBrowser: JupyterFrontEndPlugin<IDefaultFileBrowser>;
 /**
  * The default collaborative drive provider.
  */

package/lib/filebrowser.js

@@ -2,45 +2,48 @@
  * 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 { Widget } from '@lumino/widgets';
-import { IDefaultFileBrowser, IFileBrowserFactory } from '@jupyterlab/filebrowser';
 import { IStatusBar } from '@jupyterlab/statusbar';
-import { IEditorTracker } from '@jupyterlab/fileeditor';
+import { IEditorTracker, IEditorWidgetFactory } from '@jupyterlab/fileeditor';
 import { ILoggerRegistry } from '@jupyterlab/logconsole';
-import { INotebookTracker } from '@jupyterlab/notebook';
+import { INotebookTracker, INotebookWidgetFactory } from '@jupyterlab/notebook';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { ITranslator, nullTranslator } from '@jupyterlab/translation';
 import { YFile, YNotebook } from '@jupyter/ydoc';
-import { ICollaborativeDrive, IGlobalAwareness } from '@jupyter/collaborative-drive';
-import { TimelineWidget, YDrive } from '@jupyter/docprovider';
+import { ICollaborativeContentProvider, IGlobalAwareness } from '@jupyter/collaborative-drive';
+import { TimelineWidget, RtcContentProvider } from '@jupyter/docprovider';
 import { URLExt } from '@jupyterlab/coreutils';
-/**
- * The command IDs used by the file browser plugin.
- */
-var CommandIDs;
-(function (CommandIDs) {
-    CommandIDs.openPath = 'filebrowser:open-path';
-})(CommandIDs || (CommandIDs = {}));
 const DOCUMENT_TIMELINE_URL = 'api/collaboration/timeline';
 const TWO_SESSIONS_WARNING = 'The file %1 has been opened with two different views. ' +
     'This is not supported. Please close this view; otherwise, ' +
     'some of your edits may not be saved properly.';
-/**
- * The default collaborative drive provider.
- */
-export const drive = {
-    id: '@jupyter/docprovider-extension:drive',
-    description: 'The default collaborative drive provider',
-    provides: ICollaborativeDrive,
+export const rtcContentProvider = {
+    id: '@jupyter/docprovider-extension:content-provider',
+    description: 'The RTC content provider',
+    provides: ICollaborativeContentProvider,
     requires: [ITranslator],
     optional: [IGlobalAwareness],
     activate: (app, translator, globalAwareness) => {
         const trans = translator.load('jupyter_collaboration');
-        const drive = new YDrive(app.serviceManager.user, trans, globalAwareness);
-        app.serviceManager.contents.addDrive(drive);
-        return drive;
+        const defaultDrive = app.serviceManager.contents
+            .defaultDrive;
+        if (!defaultDrive) {
+            throw Error('Cannot initialize content provider: default drive property not accessible on contents manager instance.');
+        }
+        const registry = defaultDrive.contentProviderRegistry;
+        if (!registry) {
+            throw Error('Cannot initialize content provider: no content provider registry.');
+        }
+        const rtcContentProvider = new RtcContentProvider({
+            apiEndpoint: '/api/contents',
+            serverSettings: defaultDrive.serverSettings,
+            user: app.serviceManager.user,
+            trans,
+            globalAwareness
+        });
+        registry.register('rtc', rtcContentProvider);
+        return rtcContentProvider;
     }
 };
 /**
@@ -50,13 +53,13 @@ export const yfile = {
     id: '@jupyter/docprovider-extension:yfile',
     description: "Plugin to register the shared model factory for the content type 'file'",
     autoStart: true,
-    requires: [ICollaborativeDrive],
-    optional: [],
-    activate: (app, drive) => {
+    requires: [ICollaborativeContentProvider, IEditorWidgetFactory],
+    activate: (app, contentProvider, editorFactory) => {
         const yFileFactory = () => {
             return new YFile();
         };
-        drive.sharedModelFactory.registerDocumentFactory('file', yFileFactory);
+        contentProvider.sharedModelFactory.registerDocumentFactory('file', yFileFactory);
+        editorFactory.contentProviderId = 'rtc';
     }
 };
 /**
@@ -66,9 +69,9 @@ export const ynotebook = {
     id: '@jupyter/docprovider-extension:ynotebook',
     description: "Plugin to register the shared model factory for the content type 'notebook'",
     autoStart: true,
-    requires: [ICollaborativeDrive],
+    requires: [ICollaborativeContentProvider, INotebookWidgetFactory],
     optional: [ISettingRegistry],
-    activate: (app, drive, settingRegistry) => {
+    activate: (app, contentProvider, notebookFactory, settingRegistry) => {
         let disableDocumentWideUndoRedo = true;
         // Fetch settings if possible.
         if (settingRegistry) {
@@ -89,7 +92,8 @@ export const ynotebook = {
                 disableDocumentWideUndoRedo
             });
         };
-        drive.sharedModelFactory.registerDocumentFactory('notebook', yNotebookFactory);
+        contentProvider.sharedModelFactory.registerDocumentFactory('notebook', yNotebookFactory);
+        notebookFactory.contentProviderId = 'rtc';
     }
 };
 /**
@@ -99,30 +103,32 @@ export const statusBarTimeline = {
     id: '@jupyter/docprovider-extension:statusBarTimeline',
     description: 'Plugin to add a timeline slider to the status bar',
     autoStart: true,
-    requires: [IStatusBar, ICollaborativeDrive],
-    activate: async (app, statusBar, drive) => {
+    requires: [IStatusBar, ICollaborativeContentProvider],
+    activate: async (app, statusBar, contentProvider) => {
         try {
             let sliderItem = null;
             let timelineWidget = null;
             const updateTimelineForDocument = async (documentPath, documentId) => {
-                if (documentId && documentPath.split(':')[0] === 'RTC') {
-                    if (drive) {
-                        // Remove 'RTC:' from document path
-                        documentPath = documentPath.slice(drive.name.length + 1);
-                        // Dispose of the previous timelineWidget if it exists
-                        if (timelineWidget) {
-                            timelineWidget.dispose();
-                            timelineWidget = null;
-                        }
-                        const [format, type] = documentId.split(':');
-                        const provider = drive.providers.get(`${format}:${type}:${documentPath}`);
-                        const fullPath = URLExt.join(app.serviceManager.serverSettings.baseUrl, DOCUMENT_TIMELINE_URL, documentPath);
-                        timelineWidget = new TimelineWidget(fullPath, provider, provider.contentType, provider.format, DOCUMENT_TIMELINE_URL);
-                        const elt = document.getElementById('jp-slider-status-bar');
-                        if (elt && !timelineWidget.isAttached) {
-                            Widget.attach(timelineWidget, elt);
-                        }
-                    }
+                if (!documentId) {
+                    return;
+                }
+                // Dispose of the previous timelineWidget if it exists
+                if (timelineWidget) {
+                    timelineWidget.dispose();
+                    timelineWidget = null;
+                }
+                const [format, type] = documentId.split(':');
+                const provider = contentProvider.providers.get(`${format}:${type}:${documentPath}`);
+                if (!provider) {
+                    // this can happen for documents which are not provisioned with RTC
+                    return;
+                }
+                const forkProvider = provider;
+                const fullPath = URLExt.join(app.serviceManager.serverSettings.baseUrl, DOCUMENT_TIMELINE_URL, documentPath);
+                timelineWidget = new TimelineWidget(fullPath, forkProvider, forkProvider.contentType, forkProvider.format, DOCUMENT_TIMELINE_URL);
+                const elt = document.getElementById('jp-slider-status-bar');
+                if (elt && !timelineWidget.isAttached) {
+                    Widget.attach(timelineWidget, elt);
                 }
             };
             if (app.shell.currentChanged) {
@@ -155,9 +161,8 @@ export const statusBarTimeline = {
                             if (currentWidget &&
                                 currentWidget.context &&
                                 typeof currentWidget.context.path === 'string') {
-                                const documentPath = currentWidget.context.path;
                                 const documentId = currentWidget.context.model.sharedModel.getState('document_id');
-                                return !!documentId && documentPath.split(':')[0] === 'RTC';
+                                return (!!documentId && !!currentWidget.context.model.collaborative);
                             }
                             return false;
                         }
@@ -170,31 +175,6 @@ export const statusBarTimeline = {
         }
     }
 };
-/**
- * The default file browser factory provider.
- */
-export const defaultFileBrowser = {
-    id: '@jupyter/docprovider-extension:defaultFileBrowser',
-    description: 'The default file browser factory provider',
-    provides: IDefaultFileBrowser,
-    requires: [ICollaborativeDrive, IFileBrowserFactory],
-    optional: [IRouter, JupyterFrontEnd.ITreeResolver, ILabShell, ITranslator],
-    activate: async (app, drive, fileBrowserFactory, router, tree, labShell, translator) => {
-        const { commands } = app;
-        const trans = (translator !== null && translator !== void 0 ? translator : nullTranslator).load('jupyterlab');
-        app.serviceManager.contents.addDrive(drive);
-        // Manually restore and load the default file browser.
-        const defaultBrowser = fileBrowserFactory.createFileBrowser('filebrowser', {
-            auto: false,
-            restore: false,
-            driveName: drive.name
-        });
-        defaultBrowser.node.setAttribute('role', 'region');
-        defaultBrowser.node.setAttribute('aria-label', trans.__('File Browser Section'));
-        void Private.restoreBrowser(defaultBrowser, commands, router, tree, labShell);
-        return defaultBrowser;
-    }
-};
 /**
  * The default collaborative drive provider.
  */
@@ -259,49 +239,3 @@ export const logger = {
         })();
     }
 };
-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/forkManager.js

@@ -2,16 +2,16 @@
  * Copyright (c) Jupyter Development Team.
  * Distributed under the terms of the Modified BSD License.
  */
-import { ICollaborativeDrive } from '@jupyter/collaborative-drive';
+import { ICollaborativeContentProvider } from '@jupyter/collaborative-drive';
 import { ForkManager, IForkManagerToken } from '@jupyter/docprovider';
 export const forkManagerPlugin = {
     id: '@jupyter/docprovider-extension:forkManager',
     autoStart: true,
-    requires: [ICollaborativeDrive],
+    requires: [ICollaborativeContentProvider],
     provides: IForkManagerToken,
-    activate: (app, drive) => {
+    activate: (app, contentProvider) => {
         const eventManager = app.serviceManager.events;
-        const manager = new ForkManager({ drive, eventManager });
+        const manager = new ForkManager({ contentProvider, eventManager });
         return manager;
     }
 };

package/lib/index.d.ts

@@ -6,5 +6,5 @@ import { JupyterFrontEndPlugin } from '@jupyterlab/application';
 /**
  * Export the plugins as default.
  */
-declare const plugins: JupyterFrontEndPlugin<any>[];
+declare const plugins: JupyterFrontEndPlugin<unknown>[];
 export default plugins;

package/lib/index.js

@@ -4,17 +4,16 @@
  * @packageDocumentation
  * @module collaboration-extension
  */
-import { drive, yfile, ynotebook, defaultFileBrowser, logger, statusBarTimeline } from './filebrowser';
+import { rtcContentProvider, yfile, ynotebook, logger, statusBarTimeline } from './filebrowser';
 import { notebookCellExecutor } from './executor';
 import { forkManagerPlugin } from './forkManager';
 /**
  * Export the plugins as default.
  */
 const plugins = [
-    drive,
+    rtcContentProvider,
     yfile,
     ynotebook,
-    defaultFileBrowser,
     logger,
     notebookCellExecutor,
     statusBarTimeline,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider-extension",
-  "version": "3.1.0-rc.0",
+  "version": "4.0.0-alpha.0",
   "description": "JupyterLab - Collaborative Shared Models",
   "keywords": [
     "jupyter",
@@ -53,29 +53,29 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyter/collaborative-drive": "^3.1.0-rc.0",
-    "@jupyter/docprovider": "^3.1.0-rc.0",
-    "@jupyter/ydoc": "^2.0.0 || ^3.0.0",
-    "@jupyterlab/application": "^4.2.0",
-    "@jupyterlab/apputils": "^4.2.0",
-    "@jupyterlab/docregistry": "^4.2.0",
-    "@jupyterlab/filebrowser": "^4.2.0",
-    "@jupyterlab/fileeditor": "^4.2.0",
-    "@jupyterlab/logconsole": "^4.2.0",
-    "@jupyterlab/notebook": "^4.2.0",
-    "@jupyterlab/settingregistry": "^4.2.0",
-    "@jupyterlab/translation": "^4.2.0",
+    "@jupyter/collaborative-drive": "^4.0.0-alpha.0",
+    "@jupyter/docprovider": "^4.0.0-alpha.0",
+    "@jupyter/ydoc": "^2.1.3 || ^3.0.0",
+    "@jupyterlab/application": "^4.4.0-alpha.2",
+    "@jupyterlab/apputils": "^4.4.0-alpha.2",
+    "@jupyterlab/docregistry": "^4.4.0-alpha.2",
+    "@jupyterlab/filebrowser": "^4.4.0-alpha.2",
+    "@jupyterlab/fileeditor": "^4.4.0-alpha.2",
+    "@jupyterlab/logconsole": "^4.4.0-alpha.2",
+    "@jupyterlab/notebook": "^4.4.0-alpha.2",
+    "@jupyterlab/settingregistry": "^4.4.0-alpha.2",
+    "@jupyterlab/translation": "^4.4.0-alpha.2",
     "@lumino/commands": "^2.1.0",
     "y-protocols": "^1.0.5",
     "y-websocket": "^1.3.15",
     "yjs": "^13.5.40"
   },
   "devDependencies": {
-    "@jupyterlab/builder": "^4.0.0",
+    "@jupyterlab/builder": "^4.4.0-alpha.2",
     "@types/react": "~18.3.1",
     "npm-run-all": "^4.1.5",
     "rimraf": "^4.1.2",
-    "typescript": "~5.0.4"
+    "typescript": "~5.1.6"
   },
   "publishConfig": {
     "access": "public"