@jupyter/docprovider 4.0.2 → 4.1.0-alpha.0

package/lib/ydrive.d.ts

@@ -3,6 +3,7 @@ import { Contents, IContentProvider, RestContentProvider, User } from '@jupyterl
 import { ISignal } from '@lumino/signaling';
 import { IDocumentProvider, ISharedModelFactory } from '@jupyter/collaborative-drive';
 import { Awareness } from 'y-protocols/awareness';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 export interface IForkProvider {
     connectToForkDoc: (forkRoomId: string, sessionId: string) => Promise<void>;
     reconnect: () => Promise<void>;
@@ -14,6 +15,7 @@ declare namespace RtcContentProvider {
         user: User.IManager;
         trans: TranslationBundle;
         globalAwareness: Awareness | null;
+        docmanagerSettings: ISettingRegistry.ISettings | null;
     }
 }
 export declare class RtcContentProvider extends RestContentProvider implements IContentProvider {
@@ -55,5 +57,6 @@ export declare class RtcContentProvider extends RestContentProvider implements I
     private _providers;
     private _ydriveFileChanged;
     private _serverSettings;
+    private _docmanagerSettings;
 }
 export {};

package/lib/ydrive.js

@@ -4,7 +4,15 @@ import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import { RestContentProvider } from '@jupyterlab/services';
 import { Signal } from '@lumino/signaling';
 import { WebSocketProvider } from './yprovider';
+import * as encoding from 'lib0/encoding';
 const DISABLE_RTC = PageConfig.getOption('disableRTC') === 'true' ? true : false;
+const RAW_MESSAGE_TYPE = 2;
+const SAVE_MESSAGE = (() => {
+    const encoder = encoding.createEncoder();
+    encoding.writeVarUint(encoder, RAW_MESSAGE_TYPE);
+    encoding.writeVarString(encoder, 'save');
+    return encoding.toUint8Array(encoder);
+})();
 /**
  * The url for the default drive service.
  */
@@ -13,10 +21,19 @@ export class RtcContentProvider extends RestContentProvider {
     constructor(options) {
         super(options);
         this._onCreate = (options, sharedModel) => {
-            var _a, _b;
+            var _a, _b, _c, _d, _e, _f;
             if (typeof options.format !== 'string') {
                 return;
             }
+            // Set initial autosave value, used to determine backend autosave (default: true)
+            const autosave = (_c = (_b = (_a = this._docmanagerSettings) === null || _a === void 0 ? void 0 : _a.composite) === null || _b === void 0 ? void 0 : _b['autosave']) !== null && _c !== void 0 ? _c : true;
+            sharedModel.awareness.setLocalStateField('autosave', autosave);
+            // Watch for changes in settings
+            (_d = this._docmanagerSettings) === null || _d === void 0 ? void 0 : _d.changed.connect(() => {
+                var _a, _b, _c;
+                const newAutosave = (_c = (_b = (_a = this._docmanagerSettings) === null || _a === void 0 ? void 0 : _a.composite) === null || _b === void 0 ? void 0 : _b['autosave']) !== null && _c !== void 0 ? _c : true;
+                sharedModel.awareness.setLocalStateField('autosave', newAutosave);
+            });
             try {
                 const provider = new WebSocketProvider({
                     url: URLExt.join(this._serverSettings.wsUrl, DOCUMENT_PROVIDER_URL),
@@ -28,11 +45,11 @@ export class RtcContentProvider extends RestContentProvider {
                     translator: this._trans
                 });
                 // Add the document path in the list of opened ones for this user.
-                const state = ((_a = this._globalAwareness) === null || _a === void 0 ? void 0 : _a.getLocalState()) || {};
+                const state = ((_e = this._globalAwareness) === null || _e === void 0 ? void 0 : _e.getLocalState()) || {};
                 const documents = state.documents || [];
                 if (!documents.includes(options.path)) {
                     documents.push(options.path);
-                    (_b = this._globalAwareness) === null || _b === void 0 ? void 0 : _b.setLocalStateField('documents', documents);
+                    (_f = this._globalAwareness) === null || _f === void 0 ? void 0 : _f.setLocalStateField('documents', documents);
                 }
                 const key = `${options.format}:${options.contentType}:${options.path}`;
                 this._providers.set(key, provider);
@@ -92,6 +109,7 @@ export class RtcContentProvider extends RestContentProvider {
         this._serverSettings = options.serverSettings;
         this.sharedModelFactory = new SharedModelFactory(this._onCreate);
         this._providers = new Map();
+        this._docmanagerSettings = options.docmanagerSettings;
     }
     get providers() {
         return this._providers;
@@ -136,12 +154,13 @@ export class RtcContentProvider extends RestContentProvider {
      *   file is saved.
      */
     async save(localPath, options = {}) {
+        var _a, _b;
         // 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
+                (_b = (_a = provider.wsProvider) === null || _a === void 0 ? void 0 : _a.ws) === null || _b === void 0 ? void 0 : _b.send(SAVE_MESSAGE);
                 const fetchOptions = {
                     type: options.type,
                     format: options.format,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/docprovider",
-  "version": "4.0.2",
+  "version": "4.1.0-alpha.0",
   "description": "JupyterLab - Document Provider",
   "homepage": "https://github.com/jupyterlab/jupyter-collaboration",
   "bugs": {
@@ -41,7 +41,7 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyter/collaborative-drive": "^4.0.2",
+    "@jupyter/collaborative-drive": "^4.1.0-alpha.0",
     "@jupyter/ydoc": "^2.1.3 || ^3.0.0",
     "@jupyterlab/apputils": "^4.4.0",
     "@jupyterlab/cells": "^4.4.0",