@jupyter/docprovider 3.0.0-beta.1 → 3.0.0-beta.3

package/lib/ydrive.d.ts

@@ -1,5 +1,6 @@
 import { TranslationBundle } from '@jupyterlab/translation';
 import { Contents, Drive, User } from '@jupyterlab/services';
+import { ISignal } from '@lumino/signaling';
 import { ICollaborativeDrive, ISharedModelFactory } from './tokens';
 import { Awareness } from 'y-protocols/awareness';
 /**
@@ -44,9 +45,14 @@ export declare class YDrive extends Drive implements ICollaborativeDrive {
      *   file is saved.
      */
     save(localPath: string, options?: Partial<Contents.IModel>): Promise<Contents.IModel>;
+    /**
+     * A signal emitted when a file operation takes place.
+     */
+    get fileChanged(): ISignal<this, Contents.IChangedArgs>;
     private _onCreate;
     private _user;
     private _trans;
     private _providers;
     private _globalAwareness;
+    private _ydriveFileChanged;
 }

package/lib/ydrive.js

@@ -2,6 +2,7 @@
 // Distributed under the terms of the Modified BSD License.
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { Drive } from '@jupyterlab/services';
+import { Signal } from '@lumino/signaling';
 import { WebSocketProvider } from './yprovider';
 const DISABLE_RTC = PageConfig.getOption('disableRTC') === 'true' ? true : false;
 /**
@@ -44,6 +45,30 @@ export class YDrive extends Drive {
                 }
                 const key = `${options.format}:${options.contentType}:${options.path}`;
                 this._providers.set(key, provider);
+                sharedModel.changed.connect(async (_, change) => {
+                    if (!change.stateChange) {
+                        return;
+                    }
+                    const hashChanges = change.stateChange.filter(change => change.name === 'hash');
+                    if (hashChanges.length === 0) {
+                        return;
+                    }
+                    if (hashChanges.length > 1) {
+                        console.error('Unexpected multiple changes to hash value in a single transaction');
+                    }
+                    const hashChange = hashChanges[0];
+                    // A change in hash signifies that a save occurred on the server-side
+                    // (e.g. a collaborator performed the save) - we want to notify the
+                    // observers about this change so that they can store the new hash value.
+                    const model = await this.get(options.path, { content: false });
+                    this._ydriveFileChanged.emit({
+                        type: 'save',
+                        newValue: { ...model, hash: hashChange.newValue },
+                        // we do not have the old model because it was discarded when server made the change,
+                        // we only have the old hash here (which may be empty if the file was newly created!)
+                        oldValue: { hash: hashChange.oldValue }
+                    });
+                });
                 sharedModel.disposed.connect(() => {
                     var _a, _b;
                     const provider = this._providers.get(key);
@@ -67,11 +92,16 @@ export class YDrive extends Drive {
                 console.error(`Failed to open websocket connection for ${options.path}.\n:${error}`);
             }
         };
+        this._ydriveFileChanged = new Signal(this);
         this._user = user;
         this._trans = translator;
         this._globalAwareness = globalAwareness;
         this._providers = new Map();
         this.sharedModelFactory = new SharedModelFactory(this._onCreate);
+        super.fileChanged.connect((_, change) => {
+            // pass through any events from the Drive superclass
+            this._ydriveFileChanged.emit(change);
+        });
     }
     /**
      * Dispose of the resources held by the manager.
@@ -100,7 +130,7 @@ export class YDrive extends Drive {
             const key = `${options.format}:${options.type}:${localPath}`;
             const provider = this._providers.get(key);
             if (provider) {
-                // If the document does't exist, `super.get` will reject with an
+                // If the document doesn't exist, `super.get` will reject with an
                 // error and the provider will never be resolved.
                 // Use `Promise.all` to reject as soon as possible. The Context will
                 // show a dialog to the user.
@@ -140,6 +170,12 @@ export class YDrive extends Drive {
         }
         return super.save(localPath, options);
     }
+    /**
+     * A signal emitted when a file operation takes place.
+     */
+    get fileChanged() {
+        return this._ydriveFileChanged;
+    }
 }
 /**
  * Yjs sharedModel factory for real-time collaboration.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.3",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,7 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/ydoc": "^2.0.0",
+    "@jupyter/ydoc": "^2.0.0 || ^3.0.0-a3",
     "@jupyterlab/apputils": "^4.2.0",
     "@jupyterlab/cells": "^4.2.0",
     "@jupyterlab/coreutils": "^6.2.0",