@atlaskit/editor-core 190.2.2 → 191.0.0

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

@@ -1,73 +0,0 @@
-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 };
-const providerBuilder = collabEditProviderPromise => async (codeToExecute, onError) => {
-  try {
-    const provider = await collabEditProviderPromise;
-    if (provider) {
-      return codeToExecute(provider);
-    }
-  } catch (err) {
-    if (onError) {
-      onError(err);
-    } else {
-      // eslint-disable-next-line no-console
-      console.error(err);
-    }
-  }
-};
-const collabEditPlugin = ({
-  config: options,
-  api
-}) => {
-  var _api$featureFlags;
-  const featureFlags = (api === null || api === void 0 ? void 0 : (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
-  let providerResolver = () => {};
-  const collabEditProviderPromise = new Promise(_providerResolver => {
-    providerResolver = _providerResolver;
-  });
-  const executeProviderCode = providerBuilder(collabEditProviderPromise);
-  return {
-    name: 'collabEdit',
-    pmPlugins() {
-      const {
-        useNativePlugin = false,
-        userId
-      } = options || {};
-      return [...(useNativePlugin ? [{
-        name: 'pmCollab',
-        plugin: () => collab({
-          clientID: userId
-        })
-      }, {
-        name: 'nativeCollabProviderPlugin',
-        plugin: () => nativeCollabProviderPlugin({
-          providerPromise: collabEditProviderPromise
-        })
-      }] : []), {
-        name: 'collab',
-        plugin: ({
-          dispatch,
-          providerFactory
-        }) => {
-          return createPlugin(dispatch, providerFactory, providerResolver, executeProviderCode, options, featureFlags, api);
-        }
-      }];
-    },
-    onEditorViewStateUpdated(props) {
-      var _api$analytics, _options$useNativePlu;
-      const addErrorAnalytics = addSynchronyErrorAnalytics(props.newEditorState, props.newEditorState.tr, featureFlags, api === null || api === void 0 ? 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/es2019/plugins/collab-edit/native-collab-provider-plugin.js

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

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

@@ -1,57 +0,0 @@
-export class Participants {
-  constructor(participants = new Map()) {
-    this.participants = participants;
-  }
-  add(data) {
-    const newSet = new Map(this.participants);
-    data.forEach(participant => {
-      newSet.set(participant.sessionId, participant);
-    });
-    return new Participants(newSet);
-  }
-  remove(sessionIds) {
-    const newSet = new Map(this.participants);
-    sessionIds.forEach(sessionId => {
-      newSet.delete(sessionId);
-    });
-    return new Participants(newSet);
-  }
-  update(sessionId, lastActive) {
-    const newSet = new Map(this.participants);
-    const data = newSet.get(sessionId);
-    if (!data) {
-      return this;
-    }
-    newSet.set(sessionId, {
-      ...data,
-      lastActive
-    });
-    return new Participants(newSet);
-  }
-  updateCursorPos(sessionId, cursorPos) {
-    const newSet = new Map(this.participants);
-    const data = newSet.get(sessionId);
-    if (!data) {
-      return this;
-    }
-    newSet.set(sessionId, {
-      ...data,
-      cursorPos
-    });
-    return new Participants(newSet);
-  }
-  toArray() {
-    return Array.from(this.participants.values());
-  }
-  get(sessionId) {
-    return this.participants.get(sessionId);
-  }
-  size() {
-    return this.participants.size;
-  }
-  eq(other) {
-    const left = this.toArray().map(p => p.sessionId).sort((a, b) => a > b ? -1 : 1).join('');
-    const right = other.toArray().map(p => p.sessionId).sort((a, b) => a > b ? -1 : 1).join('');
-    return left === right;
-  }
-}

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

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

package/dist/es2019/plugins/collab-edit/plugin-state.js

@@ -1,218 +0,0 @@
-import _defineProperty from "@babel/runtime/helpers/defineProperty";
-import { Selection } from '@atlaskit/editor-prosemirror/state';
-import { DecorationSet } from '@atlaskit/editor-prosemirror/view';
-import { ReplaceStep } from '@atlaskit/editor-prosemirror/transform';
-import { browser } from '@atlaskit/editor-common/utils';
-import { Participants } from './participants';
-import { findPointers, createTelepointers, getPositionOfTelepointer } from './utils';
-const isReplaceStep = step => step instanceof ReplaceStep;
-export const TELEPOINTER_DIM_CLASS = 'telepointer-dim';
-
-/**
- * Returns position where it's possible to place a decoration.
- */
-export const getValidPos = (tr, pos) => {
-  const endOfDocPos = tr.doc.nodeSize - 2;
-  if (pos <= endOfDocPos) {
-    const resolvedPos = tr.doc.resolve(pos);
-    const backwardSelection = Selection.findFrom(resolvedPos, -1, true);
-    // if there's no correct cursor position before the `pos`, we try to find it after the `pos`
-    const forwardSelection = Selection.findFrom(resolvedPos, 1, true);
-    return backwardSelection ? backwardSelection.from : forwardSelection ? forwardSelection.from : pos;
-  }
-  return endOfDocPos;
-};
-export class PluginState {
-  get decorations() {
-    return this.decorationSet;
-  }
-  get activeParticipants() {
-    return this.participants;
-  }
-  get sessionId() {
-    return this.sid;
-  }
-  constructor(decorations, participants, sessionId, collabInitalised = false, onError) {
-    // eslint-disable-next-line no-console
-    _defineProperty(this, "onError", error => console.error(error));
-    this.decorationSet = decorations;
-    this.participants = participants;
-    this.sid = sessionId;
-    this.isReady = collabInitalised;
-    this.onError = onError || this.onError;
-  }
-  getInitial(sessionId) {
-    const participant = this.participants.get(sessionId);
-    return participant ? participant.name.substring(0, 1).toUpperCase() : 'X';
-  }
-  apply(tr) {
-    let {
-      participants,
-      sid,
-      isReady
-    } = this;
-    const presenceData = tr.getMeta('presence');
-    const telepointerData = tr.getMeta('telepointer');
-    const sessionIdData = tr.getMeta('sessionId');
-    let collabInitialised = tr.getMeta('collabInitialised');
-    if (typeof collabInitialised !== 'boolean') {
-      collabInitialised = isReady;
-    }
-    if (sessionIdData) {
-      sid = sessionIdData.sid;
-    }
-    let add = [];
-    let remove = [];
-    if (presenceData) {
-      const {
-        joined = [],
-        left = []
-      } = presenceData;
-      participants = participants.remove(left.map(i => i.sessionId));
-      participants = participants.add(joined);
-
-      // Remove telepointers for users that left
-      left.forEach(i => {
-        const pointers = findPointers(i.sessionId, this.decorationSet);
-        if (pointers) {
-          remove = remove.concat(pointers);
-        }
-      });
-    }
-    if (telepointerData) {
-      const {
-        sessionId
-      } = telepointerData;
-      if (participants.get(sessionId) && sessionId !== sid) {
-        const oldPointers = findPointers(telepointerData.sessionId, this.decorationSet);
-        if (oldPointers) {
-          remove = remove.concat(oldPointers);
-        }
-        const endOfDocPos = tr.doc.nodeSize - 2;
-        const anchor = telepointerData.selection.anchor;
-        const head = telepointerData.selection.head;
-        let rawFrom = anchor < head ? anchor : head;
-        let rawTo = anchor >= head ? anchor : head;
-        if (rawFrom > endOfDocPos) {
-          rawFrom = endOfDocPos;
-        }
-        if (rawTo > endOfDocPos) {
-          rawTo = endOfDocPos;
-        }
-        const isSelection = rawTo - rawFrom > 0;
-        let from = 1;
-        let to = 1;
-        try {
-          from = getValidPos(tr, isSelection ? Math.max(rawFrom - 1, 0) : rawFrom);
-          to = isSelection ? getValidPos(tr, rawTo) : from;
-        } catch (err) {
-          this.onError(err);
-        }
-        add = add.concat(createTelepointers(from, to, sessionId, isSelection, this.getInitial(sessionId)));
-      }
-    }
-    if (tr.docChanged) {
-      // Adjust decoration positions to changes made by the transaction
-      try {
-        this.decorationSet = this.decorationSet.map(tr.mapping, tr.doc, {
-          // Reapplies decorators those got removed by the state change
-          onRemove: spec => {
-            if (spec.pointer && spec.pointer.sessionId && spec.key === `telepointer-${spec.pointer.sessionId}`) {
-              const step = tr.steps.filter(isReplaceStep)[0];
-              if (step) {
-                const {
-                  sessionId
-                } = spec.pointer;
-                const {
-                  slice: {
-                    content: {
-                      size
-                    }
-                  },
-                  from
-                } = step;
-                const pos = getValidPos(tr, size ? Math.min(from + size, tr.doc.nodeSize - 3) : Math.max(from, 1));
-                add = add.concat(createTelepointers(pos, pos, sessionId, false, this.getInitial(sessionId)));
-              }
-            }
-          }
-        });
-      } catch (err) {
-        this.onError(err);
-      }
-
-      // Remove any selection decoration within the change range,
-      // takes care of the issue when after pasting we end up with a dead selection
-      tr.steps.filter(isReplaceStep).forEach(s => {
-        const {
-          from,
-          to
-        } = s;
-        this.decorationSet.find(from, to).forEach(deco => {
-          // `type` is private, `from` and `to` are public in latest version
-          // `from` != `to` means it's a selection
-          if (deco.from !== deco.to) {
-            remove.push(deco);
-          }
-        });
-      });
-    }
-    const {
-      selection
-    } = tr;
-    this.decorationSet.find().forEach(deco => {
-      if (deco.type.toDOM) {
-        const hasTelepointerDimClass = deco.type.toDOM.classList.contains(TELEPOINTER_DIM_CLASS);
-        if (deco.from === selection.from && deco.to === selection.to) {
-          if (!hasTelepointerDimClass) {
-            deco.type.toDOM.classList.add(TELEPOINTER_DIM_CLASS);
-          }
-
-          // Browser condition here to fix ED-14722 where telepointer
-          // decorations with side -1 in Firefox causes backspace issues.
-          // This is likely caused by contenteditable quirks in Firefox
-          if (!browser.gecko) {
-            deco.type.side = -1;
-          }
-        } else {
-          if (hasTelepointerDimClass) {
-            deco.type.toDOM.classList.remove(TELEPOINTER_DIM_CLASS);
-          }
-          deco.type.side = 0;
-        }
-      }
-    });
-    if (remove.length) {
-      this.decorationSet = this.decorationSet.remove(remove);
-    }
-    if (add.length) {
-      this.decorationSet = this.decorationSet.add(tr.doc, add);
-    }
-
-    // This piece needs to be after the decorationSet adjustments,
-    // otherwise it's always one step behind where the cursor is
-    if (telepointerData) {
-      const {
-        sessionId
-      } = telepointerData;
-      if (participants.get(sessionId)) {
-        const positionForScroll = getPositionOfTelepointer(sessionId, this.decorationSet);
-        if (positionForScroll) {
-          participants = participants.updateCursorPos(sessionId, positionForScroll);
-        }
-      }
-    }
-    const nextState = new PluginState(this.decorationSet, participants, sid, collabInitialised);
-    return PluginState.eq(nextState, this) ? this : nextState;
-  }
-  static eq(a, b) {
-    return a.participants === b.participants && a.sessionId === b.sessionId && a.isReady === b.isReady;
-  }
-  static init(config) {
-    const {
-      doc,
-      onError
-    } = config;
-    return new PluginState(DecorationSet.create(doc, []), new Participants(), undefined, undefined, onError);
-  }
-}

package/dist/es2019/plugins/collab-edit/plugin.js

@@ -1,83 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { initialize } from './events/initialize';
-import { PluginState } from './plugin-state';
-import { pluginKey } from './plugin-key';
-import { addSynchronyErrorAnalytics } from './analytics';
-import { fireAnalyticsEvent, ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
-export { PluginState, pluginKey };
-export const createPlugin = (dispatch, providerFactory, providerResolver, collabProviderCallback, options, featureFlags, pluginInjectionApi) => {
-  return new SafePlugin({
-    key: pluginKey,
-    state: {
-      init(config) {
-        return PluginState.init(config);
-      },
-      apply(transaction, prevPluginState, oldEditorState, newEditorState) {
-        const pluginState = prevPluginState.apply(transaction);
-        dispatch(pluginKey, pluginState);
-        return pluginState;
-      }
-    },
-    props: {
-      decorations(state) {
-        var _pluginKey$getState;
-        return (_pluginKey$getState = pluginKey.getState(state)) === null || _pluginKey$getState === void 0 ? void 0 : _pluginKey$getState.decorations;
-      }
-    },
-    filterTransaction(tr, state) {
-      const pluginState = pluginKey.getState(state);
-      const collabInitialiseTr = tr.getMeta('collabInitialised');
-
-      // Don't allow transactions that modifies the document before
-      // collab-plugin is ready.
-      if (collabInitialiseTr) {
-        return true;
-      }
-      if (!(pluginState !== null && pluginState !== void 0 && pluginState.isReady) && tr.docChanged) {
-        return false;
-      }
-      return true;
-    },
-    view(view) {
-      var _pluginInjectionApi$a, _pluginInjectionApi$a5;
-      const addErrorAnalytics = addSynchronyErrorAnalytics(view.state, view.state.tr, featureFlags, pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : (_pluginInjectionApi$a = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a === void 0 ? void 0 : _pluginInjectionApi$a.actions);
-      const onSyncUpError = attributes => {
-        var _pluginInjectionApi$a2, _pluginInjectionApi$a3, _pluginInjectionApi$a4;
-        const fireAnalyticsCallback = fireAnalyticsEvent((_pluginInjectionApi$a2 = pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : (_pluginInjectionApi$a3 = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a3 === void 0 ? void 0 : (_pluginInjectionApi$a4 = _pluginInjectionApi$a3.sharedState.currentState()) === null || _pluginInjectionApi$a4 === void 0 ? void 0 : _pluginInjectionApi$a4.createAnalyticsEvent) !== null && _pluginInjectionApi$a2 !== void 0 ? _pluginInjectionApi$a2 : undefined);
-        fireAnalyticsCallback({
-          payload: {
-            action: ACTION.NEW_COLLAB_SYNC_UP_ERROR_NO_STEPS,
-            actionSubject: ACTION_SUBJECT.EDITOR,
-            eventType: EVENT_TYPE.OPERATIONAL,
-            attributes
-          }
-        });
-      };
-      options.onSyncUpError = onSyncUpError;
-      const cleanup = collabProviderCallback(initialize({
-        view,
-        options,
-        providerFactory,
-        featureFlags,
-        editorAnalyticsApi: pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : (_pluginInjectionApi$a5 = pluginInjectionApi.analytics) === null || _pluginInjectionApi$a5 === void 0 ? void 0 : _pluginInjectionApi$a5.actions
-      }), addErrorAnalytics);
-      providerFactory && providerFactory.subscribe('collabEditProvider', (_name, providerPromise) => {
-        if (providerPromise) {
-          providerPromise.then(provider => providerResolver(provider));
-        }
-      });
-      return {
-        destroy() {
-          providerFactory.unsubscribeAll('collabEditProvider');
-          if (cleanup) {
-            cleanup.then(unsubscribe => {
-              if (unsubscribe) {
-                unsubscribe();
-              }
-            });
-          }
-        }
-      };
-    }
-  });
-};

package/dist/es2019/plugins/collab-edit/styles.js

@@ -1,45 +0,0 @@
-import { css } from '@emotion/react';
-import { TELEPOINTER_DIM_CLASS } from './plugin-state';
-import { colors } from './utils';
-import { relativeFontSizeToBase16 } from '@atlaskit/editor-shared-styles';
-const telepointerColorStyle = (color, index) => `
-  &.color-${index} {
-    background-color: ${color.selection};
-    &::after {
-      background-color: ${color.solid};
-      color: ${"var(--ds-text-inverse, #fff)"};
-      border-color: ${color.solid};
-    }
-  }
-`;
-export const telepointerStyle = css`
-  .ProseMirror .telepointer {
-    position: relative;
-    transition: opacity 200ms;
-
-    &.telepointer-selection {
-      line-height: 1.2;
-      pointer-events: none;
-      user-select: none;
-    }
-
-    &.telepointer-selection-badge::after {
-      content: attr(data-initial);
-      position: absolute;
-      display: block;
-      top: -14px;
-      font-size: ${relativeFontSizeToBase16(9)};
-      padding: ${"var(--ds-space-025, 2px)"};
-      color: ${"var(--ds-text-inverse, white)"};
-      left: -1px;
-      border-radius: 2px 2px 2px 0;
-      line-height: initial;
-    }
-
-    &.${TELEPOINTER_DIM_CLASS} {
-      opacity: 0.2;
-    }
-
-    ${colors.map((color, index) => telepointerColorStyle(color, index))};
-  }
-`;

package/dist/es2019/plugins/collab-edit/types.js

@@ -1 +0,0 @@
-export {};

package/dist/es2019/plugins/collab-edit/ui/avatars.js

@@ -1,38 +0,0 @@
-/** @jsx jsx */
-import React from 'react';
-import { jsx } from '@emotion/react';
-import AvatarGroup from '@atlaskit/avatar-group';
-import { avatarContainer } from './styles';
-import toAvatar from './to-avatar';
-import { scrollToCollabCursor } from '../utils';
-export const Avatars = /*#__PURE__*/React.memo(props => {
-  const {
-    sessionId,
-    editorView,
-    featureFlags
-  } = props;
-  const participants = props.participants.toArray();
-  const avatars = participants.sort(p => p.sessionId === sessionId ? -1 : 1).map(toAvatar);
-  if (!avatars.length) {
-    return null;
-  }
-  return jsx("div", {
-    css: avatarContainer
-  }, jsx(AvatarGroup, {
-    appearance: "stack",
-    size: "medium",
-    data: avatars,
-    maxCount: 3,
-    onAvatarClick: (_event, _analytics, index) => {
-      if (!editorView) {
-        return;
-      }
-      const allowCollabAvatarScroll = featureFlags === null || featureFlags === void 0 ? void 0 : featureFlags.collabAvatarScroll;
-
-      // user does not need to scroll to their own position (index 0)
-      if (allowCollabAvatarScroll && index > 0) {
-        scrollToCollabCursor(editorView, participants, props.sessionId, index, props.editorAnalyticsAPI);
-      }
-    }
-  }), props.children);
-});

package/dist/es2019/plugins/collab-edit/ui/colored-avatar-item.js

@@ -1,12 +0,0 @@
-/** @jsx jsx */
-import { jsx } from '@emotion/react';
-import { getAvatarColor } from '../utils';
-import { badge } from './styles';
-export const ColoredAvatarItem = props => {
-  const color = getAvatarColor(props.sessionId).color.solid;
-  const avatar = props.name.substr(0, 1).toUpperCase();
-  return jsx("div", {
-    css: badge(color),
-    "data-testid": "editor-collab-badge"
-  }, avatar);
-};