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

package/lib/ydrive.d.ts

@@ -16,17 +16,6 @@ export declare class YDrive extends Drive {
      * SharedModel factory for the YDrive.
      */
     readonly sharedModelFactory: SharedModelFactory;
-    /**
-     * 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>;
     /**
      * Dispose of the resources held by the manager.
      */
@@ -43,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.
      *
@@ -66,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;
@@ -84,11 +54,22 @@ export declare class YDrive extends Drive {
 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.

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,21 +98,29 @@ 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;
         /**
@@ -156,8 +132,14 @@ class SharedModelFactory {
             disableDocumentWideUndoRedo: true
         });
     }
+    /**
+     * Set shared document model options
+     *
+     * @param type Document type
+     * @param value Document options
+     */
     setDocumentOptions(type, value) {
-        this._documentOptions.set(type, value);
+        this._documentOptions.set(type, { ...value });
     }
     /**
      * Create a new `ISharedDocument` instance.
@@ -170,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;

package/package.json

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