@seafile/sdoc-editor 0.1.2 → 0.1.3

package/dist/socket/socket-manager.js

@@ -0,0 +1,180 @@
+import _createClass from "@babel/runtime/helpers/esm/createClass";
+import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
+import Debug from 'debug';
+import EventBus from '../utils/event-bus';
+import { syncRemoteOperations, reExecRevertOperationList, revertOperationList } from './helpers';
+import SocketClient from './socket-client';
+var debug = Debug('sdoc:socket-client');
+var SocketManager = /*#__PURE__*/_createClass(function SocketManager(editor, document, config) {
+  var _this = this;
+  _classCallCheck(this, SocketManager);
+  this.addOperations = function (operations) {
+    _this.pendingOperationList.push(operations);
+    _this.sendOperations();
+  };
+  this.getDocumentVersion = function () {
+    var version = _this.document.version;
+    return version;
+  };
+  this.sendOperations = function () {
+    if (_this.isSending || _this.pendingOperationList.length === 0) return;
+    _this.isSending = true;
+    _this.sendNextOperations();
+  };
+  this.sendNextOperations = function () {
+    if (_this.pendingOperationList.length === 0) {
+      _this.isSending = false;
+      return;
+    }
+    var version = _this.document.version;
+    var operations = _this.pendingOperationList.shift();
+    _this.socketClient.sendOperations(operations, version, _this.sendOperationsCallback);
+  };
+  this.sendOperationsCallback = function (result) {
+    if (result && result.success) {
+      var serverVersion = result.version;
+      _this.document['version'] = serverVersion;
+      _this.sendNextOperations();
+      return;
+    }
+
+    // Operations are execute failure
+    var operations = result.operations;
+    // Put the failed operation into the pending list and re-execute it
+    _this.pendingOperationList.unshift(operations);
+    _this.sendNextOperations();
+  };
+  this.receiveOperations = function (params) {
+    _this.remoteOperationsList.push(params);
+    // sort operations by version
+    if (_this.remoteOperationsList.length > 1) {
+      _this.remoteOperationsList = _this.remoteOperationsList.sort(function (prev, next) {
+        return prev.version - next.version;
+      });
+    }
+    if (_this.isExecRemoteOperations) return;
+    _this.isExecRemoteOperations = true;
+    _this.editor.isRemote = true;
+    _this.execRemoteOperations();
+
+    // reset control flag
+    Promise.resolve().then(function (_) {
+      _this.isExecRemoteOperations = false;
+      _this.editor.isRemote = false;
+    });
+  };
+  this.execRemoteOperations = function () {
+    if (_this.remoteOperationsList.length > 0) {
+      var params = _this.remoteOperationsList.shift();
+      var serverVersion = params.version;
+      var clientVersion = _this.document.version;
+      if (serverVersion === clientVersion + 1) {
+        // When performing remote operations, the revert operation is only required for the first time
+        if (_this.revertOperationList.length === 0) {
+          // 1. Revert operations
+          // 1.1 record reverted operationList & clear pendingOperationList
+          _this.revertOperationList = _this.pendingOperationList.slice();
+          _this.pendingOperationList = [];
+
+          // 1.2 Revert operationList
+          debug('revert locale operations: %O', _this.revertOperationList);
+          revertOperationList(_this.editor, _this.revertOperationList);
+        }
+
+        // 2. execute operations
+        var operations = params.operations;
+        // 2.1 Update content & version
+        debug('execute remote operations: %O', operations);
+        syncRemoteOperations(_this.editor, operations);
+
+        // 2.2 Update document
+        _this.document.version = serverVersion;
+        _this.document.children = _this.editor.children;
+
+        // Execute next operations
+        if (_this.remoteOperationsList.length > 0) {
+          _this.execRemoteOperations();
+          return;
+        }
+
+        // Re-execute undone operations after isRemote is set to false
+        // Need resend this operations to server
+        Promise.resolve().then(function (_) {
+          debug('Editor isRemote is false: %s', _this.editor.isRemote);
+          debug('Re-execute pending operations, %O', _this.revertOperationList);
+
+          // 3. Execute pending operations
+          // 3.1 Re-execute operations
+          reExecRevertOperationList(_this.editor, _this.revertOperationList);
+
+          // 3.2 Clear revert operationList
+          _this.revertOperationList = [];
+        });
+      } else {
+        // conflict: 
+        // remote operations is not empty, waiting until remote operations all executed
+        debug('remote operations is not empty, and local version is not match remote version.');
+      }
+    }
+  };
+  this.syncDocumentBySocket = function (result) {
+    var mode = result.mode,
+      content = result.content;
+    // sync document
+    if (mode === 'document') {
+      var version = content.version,
+        children = content.children;
+      // 1. update document
+      _this.document.children = children;
+      _this.document.version = version;
+      _this.editor.children = children;
+      _this.editor.isRemote = true;
+      _this.editor.onChange();
+      _this.editor.isRemote = false;
+
+      // 2. exec client operationList
+      var pendingOperationList = _this.pendingOperationList.slice();
+      _this.pendingOperationList = [];
+
+      // need resend this operations to server
+      debug('Editor isRemote is false: %s', _this.editor.isRemote);
+      reExecRevertOperationList(_this.editor, pendingOperationList);
+      return;
+    }
+
+    // sync operations
+    // content is [{version, operations}, {version, operations}, ...]
+    _this.remoteOperationsList = content;
+    _this.isExecRemoteOperations = true;
+    _this.editor.isRemote = true;
+    _this.execRemoteOperations();
+
+    // reset control flag
+    Promise.resolve().then(function (_) {
+      _this.isExecRemoteOperations = false;
+      _this.editor.isRemote = false;
+    });
+  };
+  this.dispatchConnectState = function (type, message) {
+    console.log(type);
+  };
+  this.editor = editor;
+  this.document = document;
+  this.socketClient = new SocketClient(config);
+  this.isSending = false;
+  this.pendingOperationList = []; // Two-dimensional arrays： [operations, operations, ...]
+  this.remoteOperationsList = []; // Same with pending operations
+  this.revertOperationList = [];
+  this.eventBus = new EventBus();
+});
+SocketManager.getInstance = function (editor, document, socketConfig) {
+  if (SocketManager.instance) {
+    return SocketManager.instance;
+  }
+  if (!document || !socketConfig) {
+    throw new Error('SocketManager init params is invalid. Place check your code to fix it.');
+  }
+  SocketManager.instance = new SocketManager(editor, document, socketConfig);
+  return SocketManager.instance;
+};
+export default SocketManager;

package/dist/socket/with-socket-io.js

@@ -0,0 +1,18 @@
+import SocketManager from './socket-manager';
+var withSocketIO = function withSocketIO(editor, options) {
+  var onChange = editor.onChange;
+  var newEditor = editor;
+  newEditor.onChange = function () {
+    var operations = newEditor.operations;
+    operations = operations.filter(function (item) {
+      return item.type !== 'set_selection';
+    });
+    if (!newEditor.isRemote && operations.length > 0) {
+      var socketManager = SocketManager.getInstance();
+      socketManager.addOperations && socketManager.addOperations(operations);
+    }
+    onChange();
+  };
+  return newEditor;
+};
+export default withSocketIO;

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@seafile/sdoc-editor",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "private": false,
   "description": "This is a sdoc editor",
   "main": "dist/index.js",
   "dependencies": {
     "@seafile/react-image-lightbox": "2.0.2",
+    "@seafile/slate": "0.91.8",
+    "@seafile/slate-hyperscript": "0.81.7",
+    "@seafile/slate-react": "0.92.2",
+    "deep-copy": "1.4.2",
     "is-hotkey": "0.2.0",
+    "is-url": "^1.2.4",
     "react-cookies": "0.1.1",
     "reactstrap": "8.9.0",
-    "slate": "0.91.4",
-    "slate-history": "0.86.0",
-    "slate-hyperscript": "0.77.0",
-    "slate-react": "0.92.0",
-    "socket.io-client": "4.6.1"
+    "slugid": "3.2.0",
+    "socket.io-client": "4.6.1",
+    "uuid": "9.0.0"
   },
   "scripts": {
     "clean": "rm -rf dist && mkdir dist",

package/public/locales/en/seafile-editor.json

@@ -222,5 +222,8 @@
   },
   "Select_field": "Select field",
   "Font_style": "Font style",
-  "Insert_column": "Insert column"
+  "Insert_column": "Insert column",
+  "The_link_address_is_required": "The link address is required.",
+  "The_link_title_is_required": "The link title is required.",
+  "The_link_address_is_invalid": "The link address is invalid, please enter a correct connection address."
 }

package/public/locales/zh-CN/seafile-editor.json

@@ -218,5 +218,8 @@
         }
       }
     ]
-  }
+  },
+  "The_link_address_is_required": "链接地址是必填项。",
+  "The_link_title_is_required": "链接标题是必填项。",
+  "The_link_address_is_invalid": "链接地址不合法，请输入一个正确的连接地址。"
 }

package/dist/slate-extension/core/transforms/index.js

@@ -1,2 +0,0 @@
-export * from './move-children';
-export * from './focus-editor';

package/dist/slate-extension/plugins/blockquote/render-elem.js

@@ -1,7 +0,0 @@
-import React from 'react';
-var renderBlockquote = function renderBlockquote(props, editor) {
-  var attributes = props.attributes,
-    children = props.children;
-  return /*#__PURE__*/React.createElement("blockquote", attributes, children);
-};
-export default renderBlockquote;

package/dist/slate-extension/plugins/index.js

@@ -1,9 +0,0 @@
-import HeaderPlugin from './header';
-import BlockquotePlugin from './blockquote';
-import ListPlugin from './list';
-import CheckListPlugin from './check-list';
-import TextPlugin from './text-style';
-import SocketPlugin from './socket';
-var Plugins = [HeaderPlugin, BlockquotePlugin, ListPlugin, CheckListPlugin, TextPlugin, SocketPlugin];
-export default Plugins;
-export { HeaderPlugin, BlockquotePlugin, ListPlugin, CheckListPlugin, TextPlugin, SocketPlugin };

package/dist/slate-extension/plugins/socket/index.js

@@ -1,6 +0,0 @@
-import withSocket from './plugin';
-var SocketPlugin = {
-  type: 'socket',
-  editorPlugin: withSocket
-};
-export default SocketPlugin;

package/dist/slate-extension/plugins/socket/plugin.js

@@ -1,23 +0,0 @@
-import SocketManager from "../../socket/socket-manager";
-var withSocket = function withSocket(editor) {
-  var apply = editor.apply;
-  var newEditor = editor;
-  newEditor.apply = function (operation) {
-    var isRemote = operation.is_remote;
-    if (isRemote) {
-      apply(operation);
-      return;
-    }
-
-    // 合并 op
-    try {
-      var socketManager = SocketManager.getInstance();
-      socketManager.addOperation && socketManager.addOperation(operation);
-    } catch (err) {
-      // first load, socketManager has not been init
-    }
-    apply(operation);
-  };
-  return newEditor;
-};
-export default withSocket;

package/dist/slate-extension/socket/socket-client.js

@@ -1,94 +0,0 @@
-import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
-import _createClass from "@babel/runtime/helpers/esm/createClass";
-import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
-import io from 'socket.io-client';
-import Debug from 'debug';
-import SocketManager from './socket-manager';
-var debug = Debug('sdoc:socket-client');
-var SocketClient = /*#__PURE__*/_createClass(function SocketClient(config) {
-  var _this = this;
-  _classCallCheck(this, SocketClient);
-  this.getParams = function () {
-    var params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    return _objectSpread({}, params);
-  };
-  this.onConnected = function () {
-    var socketManager = SocketManager.getInstance();
-    var _this$config = _this.config,
-      fileUuid = _this$config.fileUuid,
-      filePath = _this$config.filePath,
-      fileName = _this$config.fileName,
-      accessToken = _this$config.accessToken;
-    var params = {
-      file_uuid: fileUuid,
-      file_path: filePath,
-      file_name: fileName,
-      access_token: accessToken
-    };
-    _this.socket.emit('join-room', params, function (result) {
-      if (result.status) {
-        socketManager.dispatchConnectState('connect', result);
-        return;
-      }
-
-      // Disconnect the server in the client side. There will be no reconnection.
-      _this.socket.disconnect();
-      socketManager.dispatchConnectState('connect-error', result);
-    });
-  };
-  this.onReconnect = function (data) {
-    debug('reconnect.');
-    var socketManager = SocketManager.getInstance();
-    socketManager.dispatchConnectState('reconnect');
-  };
-  this.onReconnecting = function (attemptNumber) {
-    debug('reconnecting.', attemptNumber);
-    var socketManager = SocketManager.getInstance();
-    socketManager.dispatchConnectState('reconnecting', attemptNumber);
-  };
-  this.onDisconnected = function (data) {
-    debug('disconnect message: %s', data);
-    var socketManager = SocketManager.getInstance();
-    socketManager.dispatchConnectState('disconnect');
-  };
-  this.onJoinRoom = function (username) {
-    debug('%s joined room success.', username);
-    var socketManager = SocketManager.getInstance();
-    socketManager.dispatchConnectState('join-room', username);
-  };
-  this.onLeaveRoom = function (username) {
-    debug('%s leaved room success.', username);
-    var socketManager = SocketManager.getInstance();
-    socketManager.dispatchConnectState('leave-room', username);
-  };
-  this.sendOperation = function (operation, callback) {
-    debug('==================================');
-    debug('send operation: %s' + operation.toString());
-    debug('==================================');
-    _this.socket.emit('update-document', _this.getParams({
-      operation: operation
-    }), function (result) {
-      callback && callback(result);
-    });
-  };
-  this.receiveOperation = function (operation, version) {
-    debug('==================================');
-    debug('received operation: %s' + operation.toString());
-    debug('==================================');
-    var socketManager = SocketManager.getInstance();
-    socketManager.receiveOperation(operation, version);
-  };
-  this.disconnectWithServer = function () {
-    _this.socket.disconnect();
-  };
-  this.config = config;
-  this.socket = io(config.sdocServer);
-  this.socket.on('connect', this.onConnected);
-  this.socket.on('reconnect', this.onReconnect);
-  this.socket.on('reconnecting', this.onReconnecting);
-  this.socket.on('disconnect', this.onDisconnected);
-  this.socket.on('join-room', this.onJoinRoom);
-  this.socket.on('leave-room', this.onLeaveRoom);
-  this.socket.on('update-document', this.receiveOperation);
-});
-export default SocketClient;

package/dist/slate-extension/socket/socket-manager.js

@@ -1,63 +0,0 @@
-import _createClass from "@babel/runtime/helpers/esm/createClass";
-import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
-import EventBus from '../../utils/event-bus';
-import SocketClient from './socket-client';
-var SocketManager = /*#__PURE__*/_createClass(function SocketManager(document, config) {
-  var _this = this;
-  _classCallCheck(this, SocketManager);
-  this.addOperation = function (operation) {
-    _this.pendingOperations.push(operation);
-    _this.sendOperation();
-  };
-  this.sendOperation = function () {
-    if (_this.isSendingOperation || _this.pendingOperations.length === 0) return;
-    _this.isSendingOperation = true;
-    _this.sendNextOperation();
-  };
-  this.sendNextOperation = function () {
-    if (_this.pendingOperations.length === 0) {
-      _this.isSendingOperation = false;
-      return;
-    }
-    var operation = _this.pendingOperations.shift();
-    _this.sendingOperation = operation;
-    _this.socketClient.sendOperation(operation, _this.sendOperationCallback);
-  };
-  this.sendOperationCallback = function (result) {
-    if (result && result.success) {
-      _this.sendingOperation = null;
-      var remoteVersion = result.version;
-      var localeVersion = _this.doc.version;
-      _this.doc['version'] = remoteVersion > localeVersion ? remoteVersion : localeVersion;
-      _this.sendNextOperation();
-      return;
-    }
-
-    // operation is execute failure
-    _this.sendingOperation = null;
-    _this.sendNextOperation();
-  };
-  this.receiveOperation = function (params, last_version) {
-    _this.eventBus.dispatch('receive-operation', params);
-  };
-  this.dispatchConnectState = function (type, message) {
-    console.log(type);
-  };
-  this.doc = document;
-  this.socketClient = new SocketClient(config);
-  this.sendingOperation = null;
-  this.pendingOperations = [];
-  this.isSendingOperation = false;
-  this.eventBus = new EventBus();
-});
-SocketManager.getInstance = function (document, socketConfig) {
-  if (SocketManager.instance) {
-    return SocketManager.instance;
-  }
-  if (!document || !socketConfig) {
-    throw new Error('SocketManager init params is invalid. Place check your code to fix it.');
-  }
-  SocketManager.instance = new SocketManager(document, socketConfig);
-  return SocketManager.instance;
-};
-export default SocketManager;