@jupyter/docprovider 1.0.0-alpha.2 → 1.0.0-alpha.4

package/lib/ydrive.d.ts

@@ -1,3 +1,4 @@
+import { DocumentChange, ISharedDocument, YDocument } from '@jupyter/ydoc';
 import { TranslationBundle } from '@jupyterlab/translation';
 import { Contents, Drive, User } from '@jupyterlab/services';
 /**
@@ -14,18 +15,7 @@ export declare class YDrive extends Drive {
     /**
      * SharedModel factory for the YDrive.
      */
-    readonly sharedModelFactory: Contents.ISharedFactory;
-    /**
-     * Delete a file.
-     *
-     * @param localPath - The path to the file.
-     *
-     * @returns A promise which resolves when the file is deleted.
-     *
-     * #### Notes
-     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents).
-     */
-    delete(localPath: string): Promise<void>;
+    readonly sharedModelFactory: SharedModelFactory;
     /**
      * Dispose of the resources held by the manager.
      */
@@ -42,20 +32,6 @@ export declare class YDrive extends Drive {
      * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
      */
     get(localPath: string, options?: Contents.IFetchOptions): Promise<Contents.IModel>;
-    /**
-     * Rename a file or directory.
-     *
-     * @param oldLocalPath - The original file path.
-     *
-     * @param newLocalPath - The new file path.
-     *
-     * @returns A promise which resolves with the new file contents model when
-     *   the file is renamed.
-     *
-     * #### Notes
-     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
-     */
-    rename(oldLocalPath: string, newLocalPath: string): Promise<Contents.IModel>;
     /**
      * Save a file.
      *
@@ -65,11 +41,6 @@ export declare class YDrive extends Drive {
      *
      * @returns A promise which resolves with the file content model when the
      *   file is saved.
-     *
-     * #### Notes
-     * Ensure that `model.content` is populated for the file.
-     *
-     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
      */
     save(localPath: string, options?: Partial<Contents.IModel>): Promise<Contents.IModel>;
     private _onCreate;
@@ -77,3 +48,34 @@ export declare class YDrive extends Drive {
     private _trans;
     private _providers;
 }
+/**
+ * Yjs sharedModel factory for real-time collaboration.
+ */
+declare class SharedModelFactory implements Contents.ISharedFactory {
+    private _onCreate;
+    private _documentOptions;
+    /**
+     * Shared model factory constructor
+     *
+     * @param _onCreate Callback on new document model creation
+     */
+    constructor(_onCreate: (options: Contents.ISharedFactoryOptions, sharedModel: YDocument<DocumentChange>) => void);
+    /**
+     * Whether the IDrive supports real-time collaboration or not.
+     */
+    readonly collaborative = true;
+    /**
+     * Set shared document model options
+     *
+     * @param type Document type
+     * @param value Document options
+     */
+    setDocumentOptions(type: Contents.ContentType, value: Record<string, any>): void;
+    /**
+     * Create a new `ISharedDocument` instance.
+     *
+     * It should return `undefined` if the factory is not able to create a `ISharedDocument`.
+     */
+    createNew(options: Contents.ISharedFactoryOptions): ISharedDocument | undefined;
+}
+export {};

package/lib/ydrive.js

@@ -55,22 +55,6 @@ export class YDrive extends Drive {
         this._providers = new Map();
         this.sharedModelFactory = new SharedModelFactory(this._onCreate);
     }
-    /**
-     * Delete a file.
-     *
-     * @param localPath - The path to the file.
-     *
-     * @returns A promise which resolves when the file is deleted.
-     *
-     * #### Notes
-     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents).
-     */
-    async delete(localPath) {
-        await super.delete(localPath);
-        // FIXME
-        // We are not removing the path from `sharedPaths` as multiple providers of the same file (with different model) may exist.
-        //this._sharedPaths.delete(localPath);
-    }
     /**
      * Dispose of the resources held by the manager.
      */
@@ -105,22 +89,6 @@ export class YDrive extends Drive {
         }
         return super.get(localPath, options);
     }
-    /**
-     * Rename a file or directory.
-     *
-     * @param oldLocalPath - The original file path.
-     *
-     * @param newLocalPath - The new file path.
-     *
-     * @returns A promise which resolves with the new file contents model when
-     *   the file is renamed.
-     *
-     * #### Notes
-     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
-     */
-    async rename(oldLocalPath, newLocalPath) {
-        return await super.rename(oldLocalPath, newLocalPath);
-    }
     /**
      * Save a file.
      *
@@ -130,27 +98,48 @@ export class YDrive extends Drive {
      *
      * @returns A promise which resolves with the file content model when the
      *   file is saved.
-     *
-     * #### Notes
-     * Ensure that `model.content` is populated for the file.
-     *
-     * Uses the [Jupyter Notebook API](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyter/notebook/master/notebook/services/api/api.yaml#!/contents) and validates the response model.
      */
     async save(localPath, options = {}) {
-        // Save is done from the backend
-        return this.get(localPath, { ...options, content: false });
+        // Check that there is a provider - it won't e.g. if the document model is not collaborative.
+        if (options.format && options.type) {
+            const key = `${options.format}:${options.type}:${localPath}`;
+            const provider = this._providers.get(key);
+            if (provider) {
+                // Save is done from the backend
+                return this.get(localPath, { ...options, content: false });
+            }
+        }
+        return super.save(localPath, options);
     }
 }
 /**
  * Yjs sharedModel factory for real-time collaboration.
  */
 class SharedModelFactory {
+    /**
+     * Shared model factory constructor
+     *
+     * @param _onCreate Callback on new document model creation
+     */
     constructor(_onCreate) {
         this._onCreate = _onCreate;
         /**
          * Whether the IDrive supports real-time collaboration or not.
          */
         this.collaborative = true;
+        this._documentOptions = new Map();
+        this._documentOptions.set('notebook', {
+            disableDocumentWideUndoRedo: true
+        });
+    }
+    /**
+     * Set shared document model options
+     *
+     * @param type Document type
+     * @param value Document options
+     */
+    setDocumentOptions(type, value) {
+        this._documentOptions.set(type, { ...value });
     }
     /**
      * Create a new `ISharedDocument` instance.
@@ -163,6 +152,8 @@ class SharedModelFactory {
             return;
         }
         if (!options.collaborative) {
+            // Bail if the document model does not support collaboration
+            // the `sharedModel` will be the default one.
             return;
         }
         let sharedModel;
@@ -171,7 +162,7 @@ class SharedModelFactory {
                 sharedModel = new YFile();
                 break;
             case 'notebook':
-                sharedModel = new YNotebook();
+                sharedModel = new YNotebook(this._documentOptions.get('notebook'));
                 break;
             //default:
             // FIXME we should request a registry for the proper sharedModel

package/lib/yprovider.js

@@ -24,7 +24,11 @@ export class WebSocketProvider {
             if (event.code === 1003) {
                 console.error('Document provider closed:', event.reason);
                 showErrorMessage(this._trans.__('Session expired'), this._trans.__('The document session expired. You need to reload this browser tab.'), [Dialog.okButton({ label: this._trans.__('Reload') })])
-                    .then(r => window.location.reload())
+                    .then((r) => {
+                    if (r.button.accept) {
+                        window.location.reload();
+                    }
+                })
                     .catch(e => window.location.reload());
                 // Dispose shared model immediately. Better break the document model,
                 // than overriding data on disk.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "1.0.0-alpha.2",
+  "version": "1.0.0-alpha.4",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter_collaboration",
   "bugs": {