@jupyter/docprovider-extension 3.0.0-beta.3 → 3.0.0-beta.5

package/lib/filebrowser.d.ts

@@ -13,6 +13,10 @@ export declare const yfile: JupyterFrontEndPlugin<void>;
  * Plugin to register the shared model factory for the content type 'notebook'.
  */
 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.
  */

package/lib/filebrowser.js

@@ -4,14 +4,17 @@
  */
 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 { 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, IGlobalAwareness, YDrive } from '@jupyter/docprovider';
+import { ICollaborativeDrive, IGlobalAwareness, TimelineWidget, YDrive } from '@jupyter/docprovider';
+import { URLExt } from '@jupyterlab/coreutils';
 /**
  * The command IDs used by the file browser plugin.
  */
@@ -19,6 +22,7 @@ var CommandIDs;
 (function (CommandIDs) {
     CommandIDs.openPath = 'filebrowser:open-path';
 })(CommandIDs || (CommandIDs = {}));
+const DOCUMENT_TIMELINE_URL = 'api/collaboration/timeline';
 /**
  * The default collaborative drive provider.
  */
@@ -84,6 +88,74 @@ export const ynotebook = {
         drive.sharedModelFactory.registerDocumentFactory('notebook', yNotebookFactory);
     }
 };
+/**
+ * A plugin to add a timeline slider status item to the status bar.
+ */
+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) => {
+        try {
+            let sliderItem = null;
+            let timelineWidget = null;
+            const updateTimelineForDocument = async (documentPath, documentId) => {
+                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);
+                    const elt = document.getElementById('jp-slider-status-bar');
+                    if (elt && !timelineWidget.isAttached) {
+                        Widget.attach(timelineWidget, elt);
+                    }
+                }
+            };
+            if (app.shell.currentChanged) {
+                app.shell.currentChanged.connect(async (_, args) => {
+                    const currentWidget = args.newValue;
+                    if (timelineWidget) {
+                        // Dispose of the timelineWidget when the document is closed
+                        timelineWidget.dispose();
+                        timelineWidget = null;
+                    }
+                    if (currentWidget && 'context' in currentWidget) {
+                        await currentWidget.context.ready;
+                        await updateTimelineForDocument(currentWidget.context.path, currentWidget.context.model.sharedModel.getState('document_id'));
+                    }
+                });
+            }
+            if (statusBar) {
+                if (!sliderItem) {
+                    sliderItem = new Widget();
+                    sliderItem.addClass('jp-StatusBar-GroupItem');
+                    sliderItem.addClass('jp-mod-highlighted');
+                    sliderItem.id = 'jp-slider-status-bar';
+                    statusBar.registerStatusItem('jp-slider-status-bar', {
+                        item: sliderItem,
+                        align: 'left',
+                        rank: 4,
+                        isActive: () => {
+                            const currentWidget = app.shell.currentWidget;
+                            return !!currentWidget && 'context' in currentWidget;
+                        }
+                    });
+                }
+            }
+        }
+        catch (error) {
+            console.error('Failed to activate statusBarTimeline plugin:', error);
+        }
+    }
+};
 /**
  * The default file browser factory provider.
  */
@@ -96,10 +168,12 @@ export const defaultFileBrowser = {
         IRouter,
         JupyterFrontEnd.ITreeResolver,
         ILabShell,
-        ISettingRegistry
+        ISettingRegistry,
+        ITranslator
     ],
-    activate: async (app, drive, fileBrowserFactory, router, tree, labShell) => {
+    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', {
@@ -107,6 +181,8 @@ export const defaultFileBrowser = {
             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;
     }

package/lib/index.js

@@ -4,7 +4,7 @@
  * @packageDocumentation
  * @module collaboration-extension
  */
-import { drive, yfile, ynotebook, defaultFileBrowser, logger } from './filebrowser';
+import { drive, yfile, ynotebook, defaultFileBrowser, logger, statusBarTimeline } from './filebrowser';
 import { notebookCellExecutor } from './executor';
 /**
  * Export the plugins as default.
@@ -15,6 +15,7 @@ const plugins = [
     ynotebook,
     defaultFileBrowser,
     logger,
-    notebookCellExecutor
+    notebookCellExecutor,
+    statusBarTimeline
 ];
 export default plugins;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider-extension",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.5",
   "description": "JupyterLab - Collaborative Shared Models",
   "keywords": [
     "jupyter",
@@ -53,7 +53,7 @@
     "watch:labextension": "jupyter labextension watch ."
   },
   "dependencies": {
-    "@jupyter/docprovider": "^3.0.0-beta.3",
+    "@jupyter/docprovider": "^3.0.0-beta.5",
     "@jupyter/ydoc": "^2.0.0 || ^3.0.0-a3",
     "@jupyterlab/application": "^4.2.0",
     "@jupyterlab/apputils": "^4.2.0",