@atlaskit/editor-core 190.2.3 → 191.0.1

package/dist/esm/plugins/collab-edit/analytics.js

@@ -1,41 +0,0 @@
-import { getDocStructure } from '../../utils/document-logger';
-import { sniffUserBrowserExtensions } from '@atlaskit/editor-common/utils';
-import { ACTION, EVENT_TYPE, ACTION_SUBJECT } from '@atlaskit/editor-common/analytics';
-export var addSynchronyErrorAnalytics = function addSynchronyErrorAnalytics(state, tr, featureFlags, editorAnalyticsApi) {
-  return function (error) {
-    var browserExtensions = sniffUserBrowserExtensions({
-      extensions: ['grammarly']
-    });
-    var payload = {
-      action: ACTION.SYNCHRONY_ERROR,
-      actionSubject: ACTION_SUBJECT.EDITOR,
-      eventType: EVENT_TYPE.OPERATIONAL,
-      attributes: {
-        error: error,
-        browserExtensions: browserExtensions
-      }
-    };
-    if (featureFlags.synchronyErrorDocStructure) {
-      payload.attributes.docStructure = getDocStructure(state.doc, {
-        compact: true
-      });
-    }
-    editorAnalyticsApi === null || editorAnalyticsApi === void 0 || editorAnalyticsApi.attachAnalyticsEvent(payload)(tr);
-    return tr;
-  };
-};
-export var addSynchronyEntityAnalytics = function addSynchronyEntityAnalytics(state, tr) {
-  return function (type, editorAnalyticsApi) {
-    editorAnalyticsApi === null || editorAnalyticsApi === void 0 || editorAnalyticsApi.attachAnalyticsEvent({
-      action: type === 'error' ? ACTION.SYNCHRONY_ENTITY_ERROR : ACTION.SYNCHRONY_DISCONNECTED,
-      actionSubject: ACTION_SUBJECT.EDITOR,
-      eventType: EVENT_TYPE.OPERATIONAL,
-      attributes: {
-        // https://developer.mozilla.org/en-US/docs/Web/API/NavigatorOnLine/onLine
-        onLine: navigator.onLine,
-        visibilityState: document.visibilityState
-      }
-    })(tr);
-    return tr;
-  };
-};

package/dist/esm/plugins/collab-edit/events/handlers.js

@@ -1,82 +0,0 @@
-import { handleInit, handleConnection, handlePresence, handleTelePointer, applyRemoteData } from '../actions';
-import { addSynchronyEntityAnalytics, addSynchronyErrorAnalytics } from '../analytics';
-var effect = function effect(fn, eq) {
-  var previousDeps;
-  var cleanup;
-  return function () {
-    for (var _len = arguments.length, currentDeps = new Array(_len), _key = 0; _key < _len; _key++) {
-      currentDeps[_key] = arguments[_key];
-    }
-    if (cleanup && eq(previousDeps, currentDeps)) {
-      return cleanup;
-    }
-    cleanup = fn.apply(void 0, currentDeps);
-    previousDeps = currentDeps;
-    return cleanup;
-  };
-};
-export var subscribe = effect(function (view, provider, options, featureFlags, _providerFactory, editorAnalyticsApi) {
-  var entityRef;
-  var entityHandlers = {
-    disconnectedHandler: function disconnectedHandler() {
-      addSynchronyEntityAnalytics(view.state, view.state.tr)('disconnected', editorAnalyticsApi);
-    },
-    errorHandler: function errorHandler() {
-      addSynchronyEntityAnalytics(view.state, view.state.tr)('error', editorAnalyticsApi);
-    }
-  };
-  var unsubscribeSynchronyEntity = function unsubscribeSynchronyEntity() {
-    if (entityRef) {
-      entityRef.off('disconnected', entityHandlers.disconnectedHandler);
-      entityRef.off('error', entityHandlers.errorHandler);
-    }
-  };
-  var handlers = {
-    initHandler: function initHandler(data) {
-      view.dispatch(view.state.tr.setMeta('collabInitialised', true));
-      handleInit(data, view, options);
-    },
-    connectedHandler: function connectedHandler(data) {
-      return handleConnection(data, view);
-    },
-    dataHandler: function dataHandler(data) {
-      return applyRemoteData(data, view, options);
-    },
-    presenceHandler: function presenceHandler(data) {
-      return handlePresence(data, view);
-    },
-    telepointerHandler: function telepointerHandler(data) {
-      return handleTelePointer(data, view);
-    },
-    localStepsHandler: function localStepsHandler(data) {
-      var steps = data.steps;
-      var state = view.state;
-      var tr = state.tr;
-      steps.forEach(function (step) {
-        return tr.step(step);
-      });
-      view.dispatch(tr);
-    },
-    errorHandler: function errorHandler(error) {
-      addSynchronyErrorAnalytics(view.state, view.state.tr, featureFlags, editorAnalyticsApi)(error);
-    },
-    entityHandler: function entityHandler(_ref) {
-      var entity = _ref.entity;
-      unsubscribeSynchronyEntity();
-      if (options.EXPERIMENTAL_allowInternalErrorAnalytics) {
-        entity.on('disconnected', entityHandlers.disconnectedHandler);
-        entity.on('error', entityHandlers.errorHandler);
-        entityRef = entity;
-      }
-    }
-  };
-  provider.on('init', handlers.initHandler).on('connected', handlers.connectedHandler).on('data', handlers.dataHandler).on('presence', handlers.presenceHandler).on('telepointer', handlers.telepointerHandler).on('local-steps', handlers.localStepsHandler).on('error', handlers.errorHandler).on('entity', handlers.entityHandler);
-  return function () {
-    unsubscribeSynchronyEntity();
-    provider.off('init', handlers.initHandler).off('connected', handlers.connectedHandler).off('data', handlers.dataHandler).off('presence', handlers.presenceHandler).off('telepointer', handlers.telepointerHandler).off('local-steps', handlers.localStepsHandler).off('error', handlers.errorHandler).off('entity', handlers.entityHandler);
-  };
-}, function (previousDeps, currentDeps) {
-  return currentDeps && currentDeps.every(function (dep, i) {
-    return dep === previousDeps[i];
-  });
-});

package/dist/esm/plugins/collab-edit/events/initialize.js

@@ -1,51 +0,0 @@
-import { Step } from '@atlaskit/editor-prosemirror/transform';
-import memoizeOne from 'memoize-one';
-import { subscribe } from './handlers';
-import { pluginKey } from '../plugin-key';
-var initCollab = function initCollab(collabEditProvider, view) {
-  if (collabEditProvider.initialize) {
-    collabEditProvider.initialize(function () {
-      return view.state;
-    }, function (json) {
-      return Step.fromJSON(view.state.schema, json);
-    });
-  }
-};
-var initNewCollab = function initNewCollab(collabEditProvider, view, onSyncUpError) {
-  collabEditProvider.setup({
-    getState: function getState() {
-      return view.state;
-    },
-    onSyncUpError: onSyncUpError
-  });
-};
-var initCollabMemo = memoizeOne(initCollab);
-export var initialize = function initialize(_ref) {
-  var options = _ref.options,
-    providerFactory = _ref.providerFactory,
-    view = _ref.view,
-    featureFlags = _ref.featureFlags,
-    editorAnalyticsApi = _ref.editorAnalyticsApi;
-  return function (provider) {
-    var cleanup;
-    var pluginState = pluginKey.getState(view.state);
-    if (pluginState !== null && pluginState !== void 0 && pluginState.isReady && cleanup) {
-      cleanup();
-    }
-    cleanup = subscribe(view, provider, options, featureFlags, providerFactory, editorAnalyticsApi);
-
-    // Initialize provider
-    if (options.useNativePlugin) {
-      // ED-13912 For NCS we don't want to use memoizeOne because it causes
-      // infinite text while changing page-width
-      initNewCollab(provider, view, options.onSyncUpError);
-    } else {
-      /**
-       * We only want to initialise once, if we reload/reconfigure this plugin
-       * We dont want to re-init collab, it would break existing sessions
-       */
-      initCollabMemo(provider, view);
-    }
-    return cleanup;
-  };
-};

package/dist/esm/plugins/collab-edit/events/send-transaction.js

@@ -1,42 +0,0 @@
-import { getSendableSelection } from '../actions';
-import { pluginKey } from '../plugin-key';
-export var sendTransaction = function sendTransaction(_ref) {
-  var originalTransaction = _ref.originalTransaction,
-    transactions = _ref.transactions,
-    oldEditorState = _ref.oldEditorState,
-    newEditorState = _ref.newEditorState,
-    useNativePlugin = _ref.useNativePlugin;
-  return function (provider) {
-    var docChangedTransaction = transactions.find(function (tr) {
-      return tr.docChanged;
-    });
-    var currentPluginState = pluginKey.getState(newEditorState);
-    if (!(currentPluginState !== null && currentPluginState !== void 0 && currentPluginState.isReady)) {
-      return;
-    }
-    var shouldSendStepForSynchronyCollabProvider = !originalTransaction.getMeta('isRemote') &&
-    // TODO: ED-8995
-    // We need to do this check to reduce the number of race conditions when working with tables.
-    // This metadata is coming from the scaleTable command in table-resizing plugin
-    !originalTransaction.getMeta('scaleTable') && docChangedTransaction;
-    if (useNativePlugin || shouldSendStepForSynchronyCollabProvider) {
-      provider.send(docChangedTransaction, oldEditorState, newEditorState);
-    }
-    var prevPluginState = pluginKey.getState(oldEditorState);
-    var _ref2 = prevPluginState || {},
-      prevActiveParticipants = _ref2.activeParticipants;
-    var activeParticipants = currentPluginState.activeParticipants,
-      sessionId = currentPluginState.sessionId;
-    var selectionChanged = !oldEditorState.selection.eq(newEditorState.selection);
-    var participantsChanged = prevActiveParticipants && !prevActiveParticipants.eq(activeParticipants);
-    if (sessionId && selectionChanged && !docChangedTransaction || sessionId && participantsChanged) {
-      var selection = getSendableSelection(newEditorState.selection);
-      var message = {
-        type: 'telepointer',
-        selection: selection,
-        sessionId: sessionId
-      };
-      provider.sendMessage(message);
-    }
-  };
-};

package/dist/esm/plugins/collab-edit/get-participants-count.js

@@ -1,11 +0,0 @@
-import { pluginKey } from './plugin-key';
-export function getParticipantsCount(state) {
-  if (!state) {
-    return 1;
-  }
-  var pluginState = pluginKey.getState(state);
-  // @ts-ignore accessing private property
-  return pluginState && pluginState.participants ?
-  // @ts-ignore accessing private property
-  pluginState.participants.size() : 1;
-}

package/dist/esm/plugins/collab-edit/index.js

@@ -1,103 +0,0 @@
-import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
-import _regeneratorRuntime from "@babel/runtime/regenerator";
-import { collab } from 'prosemirror-collab';
-import { addSynchronyErrorAnalytics } from './analytics';
-import { sendTransaction } from './events/send-transaction';
-import { nativeCollabProviderPlugin } from './native-collab-provider-plugin';
-import { createPlugin, pluginKey } from './plugin';
-export { pluginKey };
-var providerBuilder = function providerBuilder(collabEditProviderPromise) {
-  return /*#__PURE__*/function () {
-    var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(codeToExecute, onError) {
-      var provider;
-      return _regeneratorRuntime.wrap(function _callee$(_context) {
-        while (1) switch (_context.prev = _context.next) {
-          case 0:
-            _context.prev = 0;
-            _context.next = 3;
-            return collabEditProviderPromise;
-          case 3:
-            provider = _context.sent;
-            if (!provider) {
-              _context.next = 6;
-              break;
-            }
-            return _context.abrupt("return", codeToExecute(provider));
-          case 6:
-            _context.next = 11;
-            break;
-          case 8:
-            _context.prev = 8;
-            _context.t0 = _context["catch"](0);
-            if (onError) {
-              onError(_context.t0);
-            } else {
-              // eslint-disable-next-line no-console
-              console.error(_context.t0);
-            }
-          case 11:
-          case "end":
-            return _context.stop();
-        }
-      }, _callee, null, [[0, 8]]);
-    }));
-    return function (_x, _x2) {
-      return _ref.apply(this, arguments);
-    };
-  }();
-};
-var collabEditPlugin = function collabEditPlugin(_ref2) {
-  var _api$featureFlags;
-  var options = _ref2.config,
-    api = _ref2.api;
-  var featureFlags = (api === null || api === void 0 || (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
-  var providerResolver = function providerResolver() {};
-  var collabEditProviderPromise = new Promise(function (_providerResolver) {
-    providerResolver = _providerResolver;
-  });
-  var executeProviderCode = providerBuilder(collabEditProviderPromise);
-  return {
-    name: 'collabEdit',
-    pmPlugins: function pmPlugins() {
-      var _ref3 = options || {},
-        _ref3$useNativePlugin = _ref3.useNativePlugin,
-        useNativePlugin = _ref3$useNativePlugin === void 0 ? false : _ref3$useNativePlugin,
-        userId = _ref3.userId;
-      return [].concat(_toConsumableArray(useNativePlugin ? [{
-        name: 'pmCollab',
-        plugin: function plugin() {
-          return collab({
-            clientID: userId
-          });
-        }
-      }, {
-        name: 'nativeCollabProviderPlugin',
-        plugin: function plugin() {
-          return nativeCollabProviderPlugin({
-            providerPromise: collabEditProviderPromise
-          });
-        }
-      }] : []), [{
-        name: 'collab',
-        plugin: function plugin(_ref4) {
-          var dispatch = _ref4.dispatch,
-            providerFactory = _ref4.providerFactory;
-          return createPlugin(dispatch, providerFactory, providerResolver, executeProviderCode, options, featureFlags, api);
-        }
-      }]);
-    },
-    onEditorViewStateUpdated: function onEditorViewStateUpdated(props) {
-      var _api$analytics, _options$useNativePlu;
-      var addErrorAnalytics = addSynchronyErrorAnalytics(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions);
-      executeProviderCode(sendTransaction({
-        originalTransaction: props.originalTransaction,
-        transactions: props.transactions,
-        oldEditorState: props.oldEditorState,
-        newEditorState: props.newEditorState,
-        useNativePlugin: (_options$useNativePlu = options === null || options === void 0 ? void 0 : options.useNativePlugin) !== null && _options$useNativePlu !== void 0 ? _options$useNativePlu : false
-      }), addErrorAnalytics);
-    }
-  };
-};
-export default collabEditPlugin;

package/dist/esm/plugins/collab-edit/native-collab-provider-plugin.js

@@ -1,31 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-var nativeCollabProviderPluginKey = new PluginKey('nativeCollabProviderPlugin');
-export var nativeCollabProviderPlugin = function nativeCollabProviderPlugin(_ref) {
-  var providerPromise = _ref.providerPromise;
-  return new SafePlugin({
-    key: nativeCollabProviderPluginKey,
-    state: {
-      init: function init() {
-        return null;
-      },
-      apply: function apply(tr, currentPluginState) {
-        var provider = tr.getMeta(nativeCollabProviderPluginKey);
-        return provider ? provider : currentPluginState;
-      }
-    },
-    view: function view(editorView) {
-      providerPromise.then(function (provider) {
-        var dispatch = editorView.dispatch,
-          state = editorView.state;
-        var tr = state.tr;
-        tr.setMeta(nativeCollabProviderPluginKey, provider);
-        dispatch(tr);
-      });
-      return {};
-    }
-  });
-};
-export var getCollabProvider = function getCollabProvider(editorState) {
-  return nativeCollabProviderPluginKey.getState(editorState);
-};

package/dist/esm/plugins/collab-edit/participants.js

@@ -1,88 +0,0 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
-import _createClass from "@babel/runtime/helpers/createClass";
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-export var Participants = /*#__PURE__*/function () {
-  function Participants() {
-    var participants = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : new Map();
-    _classCallCheck(this, Participants);
-    this.participants = participants;
-  }
-  _createClass(Participants, [{
-    key: "add",
-    value: function add(data) {
-      var newSet = new Map(this.participants);
-      data.forEach(function (participant) {
-        newSet.set(participant.sessionId, participant);
-      });
-      return new Participants(newSet);
-    }
-  }, {
-    key: "remove",
-    value: function remove(sessionIds) {
-      var newSet = new Map(this.participants);
-      sessionIds.forEach(function (sessionId) {
-        newSet.delete(sessionId);
-      });
-      return new Participants(newSet);
-    }
-  }, {
-    key: "update",
-    value: function update(sessionId, lastActive) {
-      var newSet = new Map(this.participants);
-      var data = newSet.get(sessionId);
-      if (!data) {
-        return this;
-      }
-      newSet.set(sessionId, _objectSpread(_objectSpread({}, data), {}, {
-        lastActive: lastActive
-      }));
-      return new Participants(newSet);
-    }
-  }, {
-    key: "updateCursorPos",
-    value: function updateCursorPos(sessionId, cursorPos) {
-      var newSet = new Map(this.participants);
-      var data = newSet.get(sessionId);
-      if (!data) {
-        return this;
-      }
-      newSet.set(sessionId, _objectSpread(_objectSpread({}, data), {}, {
-        cursorPos: cursorPos
-      }));
-      return new Participants(newSet);
-    }
-  }, {
-    key: "toArray",
-    value: function toArray() {
-      return Array.from(this.participants.values());
-    }
-  }, {
-    key: "get",
-    value: function get(sessionId) {
-      return this.participants.get(sessionId);
-    }
-  }, {
-    key: "size",
-    value: function size() {
-      return this.participants.size;
-    }
-  }, {
-    key: "eq",
-    value: function eq(other) {
-      var left = this.toArray().map(function (p) {
-        return p.sessionId;
-      }).sort(function (a, b) {
-        return a > b ? -1 : 1;
-      }).join('');
-      var right = other.toArray().map(function (p) {
-        return p.sessionId;
-      }).sort(function (a, b) {
-        return a > b ? -1 : 1;
-      }).join('');
-      return left === right;
-    }
-  }]);
-  return Participants;
-}();

package/dist/esm/plugins/collab-edit/plugin-key.js

@@ -1,2 +0,0 @@
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-export var pluginKey = new PluginKey('collabEditPlugin');