@seafile/comment-editor 0.0.1-alpha.0

package/dist/basic-sdk/slate-convert/slate-to-md/transform.js

@@ -0,0 +1,344 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.formatSlateToMd = void 0;
+var _slate = require("@seafile/slate");
+var _isPunctuationMark = _interopRequireDefault(require("../../utils/is-punctuation-mark"));
+const generateDefaultText = value => {
+  return {
+    type: 'text',
+    value: value || ''
+  };
+};
+const transformTextNode = textNode => {
+  let mdNode = {
+    type: 'text',
+    value: textNode.text
+  };
+
+  // code = true, override text type
+  if (textNode['code']) {
+    mdNode = {
+      ...mdNode,
+      type: 'inlineCode'
+    };
+  }
+
+  // blob = true, add strong parent
+  if (textNode['bold']) {
+    mdNode['value'] = mdNode.value ? mdNode.value.trim() : '';
+    if ((0, _isPunctuationMark.default)(mdNode.value)) {
+      // https://symbl.cc/en/200B/
+      mdNode['value'] = mdNode.value + '​';
+    }
+    mdNode = {
+      type: 'strong',
+      children: [mdNode]
+    };
+  }
+
+  // italic = true, add emphasis parent
+  if (textNode['italic'] && mdNode.type === 'strong') {
+    mdNode = {
+      type: 'emphasis',
+      children: [mdNode]
+    };
+  } else if (textNode['italic']) {
+    mdNode['value'] = mdNode.value ? mdNode.value.trim() : '';
+    if ((0, _isPunctuationMark.default)(mdNode.value)) {
+      // https://symbl.cc/en/200B/
+      mdNode['value'] = mdNode.value + '​';
+    }
+    mdNode = {
+      type: 'emphasis',
+      children: [mdNode]
+    };
+  }
+  return mdNode;
+};
+const transformInlineChildren = (result, item) => {
+  // image
+  if (item.type && item.type === 'image') {
+    const {
+      data
+    } = item;
+    let image = {
+      type: 'image',
+      url: data.src,
+      alt: data.alt || null,
+      title: data.title || null
+    };
+    if (data.height || data.width) {
+      image = {
+        type: 'html',
+        value: `<img src="${data.src}" alt="${data.alt}" title="${data.title}" width="${data.width}" height="${data.height}" />`
+      };
+    }
+    result.push(image);
+    return result;
+  }
+
+  // link
+  if (item.type && item.type === 'link') {
+    const link = {
+      type: 'link',
+      url: item.href,
+      title: item.title || null,
+      children: [transformTextNode(item.children[0])]
+    };
+    result.push(link);
+    return result;
+  }
+
+  // mention
+  if (item.type && item.type === 'mention') {
+    result.push({
+      type: 'text',
+      value: item.children[0].text + ' '
+    });
+    return result;
+  }
+
+  // TODO: seatable
+  if (item.type && item.type === 'seatable_column') {
+    const data = item.data;
+    const newNode = {
+      text: `{${data.name}}`
+    };
+    const column = transformTextNode(newNode);
+    result.push(column);
+    return result;
+  }
+
+  // text
+  const nodes = transformTextNode(item);
+  result.push(nodes);
+  return result;
+};
+const transformNodeWithInlineChildren = node => {
+  const {
+    children
+  } = node;
+  const defaultChildren = [generateDefaultText()];
+  if (!children || !Array.isArray(children) || children.length === 0) {
+    return defaultChildren;
+  }
+  const result = [];
+  children.forEach(item => transformInlineChildren(result, item));
+  return result.flat();
+};
+const transformHeader = node => {
+  const level = node.type.replace('header', '');
+  return {
+    type: 'heading',
+    depth: parseInt(level),
+    children: transformNodeWithInlineChildren(node)
+  };
+};
+const transformParagraph = node => {
+  const {
+    children
+  } = node;
+  if (!Array.isArray(children) || children.length === 0) {
+    return {
+      type: 'paragraph',
+      children: transformNodeWithInlineChildren(node)
+    };
+  }
+
+  // TODO: seatable
+  const voidNodeTypes = ['image', 'seatable_column', 'formula'];
+  const hasBlock = children.some(item => voidNodeTypes.includes(item.type));
+  if (!hasBlock && _slate.Node.string(node).length === 0) {
+    return {
+      type: 'paragraph',
+      children: [
+      // https://symbl.cc/en/200B/
+      generateDefaultText('​')]
+    };
+  }
+  return {
+    type: 'paragraph',
+    children: transformNodeWithInlineChildren(node)
+  };
+};
+const transformBlockquote = node => {
+  const {
+    children
+  } = node;
+  return {
+    type: 'blockquote',
+    children: children.map(child => {
+      const handler = elementHandlers[child.type];
+      return handler(child);
+    }).flat() // flat
+  };
+};
+const transformCheckList = node => {
+  return {
+    type: 'list',
+    ordered: false,
+    start: null,
+    spread: false,
+    children: [{
+      type: 'listItem',
+      spread: false,
+      checked: node.checked ? true : false,
+      children: [transformParagraph(node)]
+    }]
+  };
+};
+const transformListContent = node => {
+  return transformParagraph(node);
+};
+const transformListItem = node => {
+  let loose = false;
+  const {
+    children
+  } = node;
+  // eslint-disable-next-line array-callback-return
+  const newChildren = children.map(child => {
+    if (child.type === 'paragraph') {
+      return transformListContent(child);
+    }
+    if (child.type === 'code_block') {
+      return transformCodeBlock(child);
+    }
+    if (child.type === 'blockquote') {
+      return transformBlockquote(child);
+    }
+    if (child.type === 'unordered_list' || child.type === 'ordered_list') {
+      return transformList(child);
+    }
+  });
+  if (newChildren.length === 1) {
+    loose = false;
+  } else if (newChildren.length === 2 && newChildren[1].type === 'list') {
+    loose = true;
+  } else {
+    loose = true;
+  }
+  return {
+    type: 'listItem',
+    loose: loose,
+    checked: null,
+    children: newChildren
+  };
+};
+const transformList = node => {
+  const {
+    children
+  } = node;
+  const newChildren = children.map(child => transformListItem(child));
+  let loose = false;
+  for (let node of newChildren) {
+    if (node.loose === true) {
+      loose = true;
+      break;
+    }
+  }
+  return {
+    type: 'list',
+    ordered: node.type === 'ordered_list',
+    // ordered_list | unordered_list
+    start: 1,
+    loose: loose,
+    children: newChildren
+  };
+};
+const transformTableCell = cell => {
+  return {
+    type: 'tableCell',
+    children: transformNodeWithInlineChildren(cell)
+  };
+};
+const transformTableRow = row => {
+  const {
+    children: cells
+  } = row;
+  return {
+    type: 'tableRow',
+    children: cells.map(cell => transformTableCell(cell))
+  };
+};
+const transformTable = node => {
+  const {
+    children: rows
+  } = node;
+  const align = rows.map(row => {
+    var _cells$;
+    const {
+      children: cells
+    } = row;
+    return ((_cells$ = cells[0]) === null || _cells$ === void 0 ? void 0 : _cells$.align) || null;
+  });
+  return {
+    type: 'table',
+    align: align,
+    children: rows.map(row => transformTableRow(row))
+  };
+};
+const transformCodeLine = node => {
+  var _node$children$;
+  const text = ((_node$children$ = node.children[0]) === null || _node$children$ === void 0 ? void 0 : _node$children$.text) || '';
+  return text;
+};
+const transformCodeBlock = node => {
+  const {
+    children
+  } = node;
+  return {
+    type: 'code',
+    lang: node.lang ? node.lang : null,
+    value: children.map(child => transformCodeLine(child)).join('\n')
+  };
+};
+const transformFormula = node => {
+  const data = node.data;
+  return {
+    type: 'math',
+    value: data.formula
+  };
+};
+const transformMention = node => {
+  const data = node.data;
+  return {
+    type: 'mention',
+    value: data.value
+  };
+};
+const transformImageBlock = node => {
+  return {
+    type: 'paragraph',
+    children: transformNodeWithInlineChildren(node)
+  };
+};
+const elementHandlers = {
+  'paragraph': transformParagraph,
+  'header1': transformHeader,
+  'header2': transformHeader,
+  'header3': transformHeader,
+  'header4': transformHeader,
+  'header5': transformHeader,
+  'header6': transformHeader,
+  'blockquote': transformBlockquote,
+  'table': transformTable,
+  'check_list_item': transformCheckList,
+  'ordered_list': transformList,
+  'unordered_list': transformList,
+  'code_block': transformCodeBlock,
+  'formula': transformFormula,
+  'mention': transformMention,
+  'image_block': transformImageBlock
+};
+const formatSlateToMd = children => {
+  const validChildren = children.filter(child => elementHandlers[child.type]);
+  return validChildren.map(child => {
+    const handler = elementHandlers[child.type];
+    return handler(child);
+  }).flat();
+};
+exports.formatSlateToMd = formatSlateToMd;

package/dist/basic-sdk/socket/helpers.js

@@ -0,0 +1,299 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateOperation = exports.syncRemoteOperations = exports.syncRemoteCursorLocation = exports.revertOperationList = exports.reExecRevertOperationList = exports.getRevertOperationList = exports.getNodePathById = void 0;
+var _slate = require("@seafile/slate");
+var _deepCopy = _interopRequireDefault(require("deep-copy"));
+var _helper = require("../cursor/helper");
+var _core = require("../extension/core");
+var OPERATION = _interopRequireWildcard(require("../node-id/constants"));
+const getNodePathById = function (rootNode, nodeId) {
+  let path = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
+  if (rootNode.id === nodeId) return path;
+  const {
+    children = []
+  } = rootNode;
+  for (let i = 0; i < children.length; i++) {
+    const child = children[i];
+    path.push(i);
+    const nodePath = getNodePathById(child, nodeId, path);
+    if (nodePath) return nodePath;
+    path.pop();
+  }
+  return null;
+};
+exports.getNodePathById = getNodePathById;
+const validateOperation = (editor, operation) => {
+  let isValid = false;
+  let newOperation = (0, _deepCopy.default)(operation);
+  const {
+    type
+  } = newOperation;
+  switch (type) {
+    case OPERATION.INSERT_TEXT:
+    case OPERATION.REMOVE_TEXT:
+      {
+        const {
+          node_id,
+          path
+        } = newOperation;
+        const node = (0, _core.getNode)(editor, path);
+        // node is exist and node path is not changed
+        if (node && node.id === node_id) {
+          isValid = true;
+          break;
+        }
+
+        // node is exist but node path is changed
+        const nodePath = getNodePathById(editor, node_id);
+        if (nodePath) {
+          isValid = true;
+          newOperation.path = nodePath;
+          break;
+        }
+        // node is not exist
+        isValid = false;
+        break;
+      }
+    case OPERATION.INSERT_NODE:
+      {
+        let {
+          parent_node_id,
+          path
+        } = newOperation;
+        const parentNodePath = getNodePathById(editor, parent_node_id);
+        if (!parentNodePath) {
+          isValid = false;
+          break;
+        }
+        const parentPath = path.slice(0, path.length - 1);
+        if (parentPath.join() === parentNodePath.join()) {
+          isValid = true;
+          break;
+        }
+
+        // reset insert node path
+        const parentNode = (0, _core.getNode)(editor, path);
+        if (parentNode) {
+          const childLength = parentNode.children.length;
+          const index = Math.min(path[path.length - 1], childLength);
+          newOperation.path = parentNodePath.concat([index]);
+          isValid = true;
+        }
+        break;
+      }
+    case OPERATION.REMOVE_NODE:
+      {
+        const {
+          node_id,
+          path
+        } = newOperation;
+        const node = (0, _core.getNode)(editor, path);
+        // node is exist and node path is not changed
+        if (node && node.id === node_id) {
+          isValid = true;
+          break;
+        }
+
+        // node is exist but node path is changed
+        const nodePath = getNodePathById(editor, node_id);
+        if (nodePath) {
+          isValid = true;
+          newOperation.path = nodePath;
+          break;
+        }
+
+        // node is not exist
+        isValid = false;
+        break;
+      }
+    case OPERATION.MERGE_NODE:
+      {
+        // merge next node into prev node
+        const {
+          node_id,
+          path
+        } = newOperation;
+        const node = (0, _core.getNode)(editor, path);
+        // node is exist and node path is not changed
+        if (node && node.id === node_id) {
+          isValid = true;
+          break;
+        }
+
+        // node is exist but node path is changed
+        const nodePath = getNodePathById(editor, node_id);
+        if (nodePath) {
+          isValid = true;
+          newOperation.path = nodePath;
+          break;
+        }
+
+        // node is not exist
+        isValid = false;
+        break;
+      }
+    case OPERATION.SPLIT_NODE:
+      {
+        const {
+          node_id,
+          path
+        } = newOperation;
+        const node = (0, _core.getNode)(editor, path);
+        // node is exist and node path is not changed
+        if (node && node.id === node_id) {
+          isValid = true;
+          break;
+        }
+
+        // node is exist but node path is changed
+        const nodePath = getNodePathById(editor, node_id);
+        if (nodePath) {
+          isValid = true;
+          newOperation.path = nodePath;
+          break;
+        }
+
+        // node is not exist
+        isValid = false;
+        break;
+      }
+    case OPERATION.SET_NODE:
+      {
+        const {
+          node_id,
+          path,
+          properties
+        } = newOperation;
+        const node = (0, _core.getNode)(editor, path);
+        // node is exist and node path is not changed
+        if (node && node.id === node_id) {
+          isValid = true;
+          newOperation.properties = {
+            ...properties,
+            type: node.type
+          };
+          break;
+        }
+
+        // node is exist but node path is changed
+        const nodePath = getNodePathById(editor, node_id);
+        if (nodePath) {
+          isValid = true;
+          const node = (0, _core.getNode)(editor, nodePath);
+          newOperation.properties = {
+            ...properties,
+            type: node.type
+          };
+          newOperation.path = nodePath;
+          break;
+        }
+
+        // node is not exist
+        isValid = false;
+        break;
+      }
+    case OPERATION.MOVE_NODE:
+      {
+        const {
+          node_id,
+          path
+        } = newOperation;
+        const node = (0, _core.getNode)(editor, path);
+        // node is exist and node path is not changed
+        if (node && node.id === node_id) {
+          isValid = true;
+          break;
+        }
+
+        // TODO: newPath can not calculate by nodePath
+        // node is exist but node path is changed
+        // const nodePath = getNodePathById(editor, node_id);
+        // if (nodePath) {}
+
+        // node is not exist
+        isValid = false;
+        break;
+      }
+    default:
+      {
+        // set_selection
+        break;
+      }
+  }
+  if (isValid) return newOperation;
+  return isValid;
+};
+exports.validateOperation = validateOperation;
+const getRevertOperationList = operationList => {
+  if (operationList.length === 0) return [];
+
+  // Generate a duplicate operationList, The original value cannot be modified here
+  let revertOperationList = (0, _deepCopy.default)(operationList);
+  revertOperationList = revertOperationList.reverse();
+  return revertOperationList.map(operations => {
+    const ops = operations.reverse();
+    return ops.map(item => _slate.Operation.inverse(item));
+  });
+};
+exports.getRevertOperationList = getRevertOperationList;
+const revertOperationList = (editor, operationList) => {
+  if (operationList.length === 0) return [];
+  const revertOperationList = getRevertOperationList(operationList);
+
+  // Cancel locale execute operations
+  for (let i = 0; i < revertOperationList.length; i++) {
+    const operations = revertOperationList[i];
+    _slate.Editor.withoutNormalizing(editor, () => {
+      for (let j = 0; j < operations.length; j++) {
+        const op = operations[j];
+        editor.apply(op);
+      }
+    });
+  }
+};
+exports.revertOperationList = revertOperationList;
+const reExecRevertOperationList = (editor, revertOperationList) => {
+  if (revertOperationList.length === 0) return;
+
+  // Re-execute revert operations
+  for (let i = 0; i < revertOperationList.length; i++) {
+    const operations = revertOperationList[i];
+    _slate.Editor.withoutNormalizing(editor, () => {
+      for (let j = 0; j < operations.length; j++) {
+        const op = validateOperation(editor, operations[j]);
+        if (op) {
+          editor.apply(op);
+        }
+      }
+    });
+  }
+};
+exports.reExecRevertOperationList = reExecRevertOperationList;
+const syncRemoteOperations = (editor, remoteOperations) => {
+  if (remoteOperations.length === 0) return;
+  _slate.Editor.withoutNormalizing(editor, () => {
+    for (let i = 0; i < remoteOperations.length; i++) {
+      const op = remoteOperations[i];
+      if (op.type === 'set_selection') {
+        continue;
+      }
+      editor.apply(op);
+    }
+  });
+};
+exports.syncRemoteOperations = syncRemoteOperations;
+const syncRemoteCursorLocation = (editor, user, location, cursorData) => {
+  const currentUser = editor.user;
+  if (user && user.username !== currentUser.username) {
+    (0, _helper.setCursor)(editor, user, location, cursorData);
+
+    // sync cursor position
+    editor.onCursor && editor.onCursor(editor.cursors);
+  }
+};
+exports.syncRemoteCursorLocation = syncRemoteCursorLocation;

package/dist/basic-sdk/socket/index.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "SocketManager", {
+  enumerable: true,
+  get: function () {
+    return _socketManager.default;
+  }
+});
+Object.defineProperty(exports, "withSocketIO", {
+  enumerable: true,
+  get: function () {
+    return _withSocketIo.default;
+  }
+});
+var _socketManager = _interopRequireDefault(require("./socket-manager"));
+var _withSocketIo = _interopRequireDefault(require("./with-socket-io"));