@atlaskit/editor-core 183.0.12 → 183.1.0

package/dist/esm/plugins/card/pm-plugins/analytics/events-from-tr.js

@@ -5,20 +5,19 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 import { AddMarkStep, RemoveMarkStep } from 'prosemirror-transform';
 import { ACTION } from '@atlaskit/editor-common/analytics';
-import { isLinkMark } from '@atlaskit/editor-common/utils';
+import { isLinkMark, pmHistoryPluginKey } from '@atlaskit/editor-common/utils';
 import { getLinkMetadataFromTransaction } from '@atlaskit/editor-common/card';
 import { LinkMetaStep } from '@atlaskit/adf-schema/steps';
-import { pmHistoryPluginKey } from '../../../history/pm-history-types';
 import { getPluginState } from '../util/state';
 import { pluginKey } from '../plugin-key';
-import { isLink, linkObjectFromNode, getLinkUrl, appearanceForLink, findLinksAtPositions } from './utils';
-var findLinksInNodeRange = function findLinksInNodeRange(node, schema, from, to) {
+import { isLink, linkObjectFromNode, getLinkUrl, getLinkNodeContext, appearanceForLink, findLinksAtPositions, areSameLinks } from './utils';
+var findLinksInNodeRange = function findLinksInNodeRange(doc, schema, from, to) {
   var links = [];
-  node.nodesBetween(from, to, function (node, pos) {
+  doc.nodesBetween(from, to, function (node, pos) {
     if (isLink(schema, node)) {
       var entireLinkInRange = pos >= from && pos + node.nodeSize <= to;
       if (entireLinkInRange) {
-        var link = linkObjectFromNode(schema, node, pos);
+        var link = linkObjectFromNode(doc, schema, node, pos);
         if (link) {
           links.push(link);
         }
@@ -41,10 +40,13 @@ export var findChangedLinks = function findChangedLinks(tr, state) {
   var isRedo = isHistoryMeta(historyMeta) && historyMeta.redo === true;
   var isUpdate = isUpdateTr(tr, isUndo || isRedo);
   var _loop = function _loop(i) {
+    var _tr$docs$i, _tr$docs;
     var step = tr.steps[i];
     var stepMap = step.getMap();
     var removedInStep = [];
     var insertedInStep = [];
+    var before = (_tr$docs$i = tr.docs[i]) !== null && _tr$docs$i !== void 0 ? _tr$docs$i : tr.before;
+    var after = (_tr$docs = tr.docs[i + 1]) !== null && _tr$docs !== void 0 ? _tr$docs : tr.doc;
 
     /**
      * AddMarkStep and RemoveMarkSteps don't produce stepMap ranges
@@ -60,27 +62,26 @@ export var findChangedLinks = function findChangedLinks(tr, state) {
         insertedInStep.push({
           type: 'mark',
           pos: addMarkStep.from,
-          mark: addMarkStep.mark
+          mark: addMarkStep.mark,
+          nodeContext: getLinkNodeContext(after, addMarkStep.from)
         });
       }
     }
     if (step instanceof RemoveMarkStep) {
       var removeMarkStep = step;
       if (isLinkMark(removeMarkStep.mark, schema)) {
-        /**
-         * For url text pasted on plain text
-         */
         removedInStep.push({
           type: 'mark',
           pos: removeMarkStep.from,
-          mark: removeMarkStep.mark
+          mark: removeMarkStep.mark,
+          nodeContext: getLinkNodeContext(before, removeMarkStep.from)
         });
       }
     }
     stepMap.forEach(function (oldStart, oldEnd, newStart, newEnd) {
-      var _tr$docs;
+      var _tr$docs2;
       var before = tr.docs[i];
-      var after = (_tr$docs = tr.docs[i + 1]) !== null && _tr$docs !== void 0 ? _tr$docs : tr.doc;
+      var after = (_tr$docs2 = tr.docs[i + 1]) !== null && _tr$docs2 !== void 0 ? _tr$docs2 : tr.doc;
       var removedInRange = [];
       var insertedInRange = [];
 
@@ -129,6 +130,19 @@ export var findChangedLinks = function findChangedLinks(tr, state) {
     inserted.push.apply(inserted, _toConsumableArray(findLinksAtPositions(tr, positions)));
   }
   if (!isUpdate) {
+    var _getLinkMetadataFromT = getLinkMetadataFromTransaction(tr),
+      inputMethod = _getLinkMetadataFromT.inputMethod;
+    /**
+     * If there is no identifiable input method, and the links inserted and removed appear to be the same,
+     * then this transaction likely is not intended to be consided to be the insertion and removal of links
+     */
+    if (!inputMethod && areSameLinks(removed, inserted)) {
+      return {
+        removed: [],
+        inserted: [],
+        updated: updated
+      };
+    }
     return {
       removed: removed,
       inserted: inserted,
@@ -264,10 +278,10 @@ export function eventsFromTransaction(tr, state) {
     /**
      * Retrieve metadata from the LinkMetaStep(s) in the transaction
      */
-    var _getLinkMetadataFromT = getLinkMetadataFromTransaction(tr),
-      action = _getLinkMetadataFromT.action,
-      inputMethod = _getLinkMetadataFromT.inputMethod,
-      sourceEvent = _getLinkMetadataFromT.sourceEvent;
+    var _getLinkMetadataFromT2 = getLinkMetadataFromTransaction(tr),
+      action = _getLinkMetadataFromT2.action,
+      inputMethod = _getLinkMetadataFromT2.inputMethod,
+      sourceEvent = _getLinkMetadataFromT2.sourceEvent;
     var contextualData = {
       action: action,
       inputMethod: inputMethod,
@@ -279,7 +293,7 @@ export function eventsFromTransaction(tr, state) {
       removed = _findChangedLinks.removed,
       inserted = _findChangedLinks.inserted,
       updated = _findChangedLinks.updated;
-    var MAX_LINK_EVENTS = 10;
+    var MAX_LINK_EVENTS = 50;
     if ([removed, inserted, updated].some(function (arr) {
       return arr.length > MAX_LINK_EVENTS;
     })) {
@@ -298,7 +312,8 @@ export function eventsFromTransaction(tr, state) {
           data: _objectSpread(_objectSpread({}, contextualData), {}, {
             url: url,
             display: display,
-            previousDisplay: previousDisplay
+            previousDisplay: previousDisplay,
+            nodeContext: link.nodeContext
           })
         });
       }
@@ -313,7 +328,8 @@ export function eventsFromTransaction(tr, state) {
             type: type,
             data: _objectSpread(_objectSpread({}, contextualData), {}, {
               url: _url,
-              display: _display
+              display: _display,
+              nodeContext: _link.nodeContext
             })
           });
         }

package/dist/esm/plugins/card/pm-plugins/analytics/utils.js

@@ -48,15 +48,18 @@ export var isLink = function isLink(schema, node) {
  * @param fragment Fragment to search
  * @returns Array of nodes and marks found in the fragment that are "links"
  */
-export function findLinksInNode(schema, node, offset) {
+export function findLinksInNode(doc, schema, node, offset) {
   var links = [];
   node.descendants(function (node, pos) {
+    var nodeContext = getLinkNodeContext(doc, pos);
+
     // Nodes
     if (isLinkNode(node)) {
       links.push({
         type: 'node',
         pos: pos + offset,
-        node: node
+        node: node,
+        nodeContext: nodeContext
       });
     }
 
@@ -68,7 +71,8 @@ export function findLinksInNode(schema, node, offset) {
           links.push({
             type: 'mark',
             pos: pos + offset,
-            mark: mark
+            mark: mark,
+            nodeContext: nodeContext
           });
         }
       }
@@ -84,12 +88,25 @@ export function getLinkUrl(link) {
   }
   return (_link$mark$attrs = link.mark.attrs) === null || _link$mark$attrs === void 0 ? void 0 : _link$mark$attrs.href;
 }
-export var linkObjectFromNode = function linkObjectFromNode(schema, node, pos) {
+export var getLinkNodeContext = function getLinkNodeContext(doc, pos) {
+  var $pos = doc.resolve(pos);
+  var maxDepth = 3;
+  for (var i = 0; i <= maxDepth; i++) {
+    var node = $pos.node($pos.depth - i);
+    if (node && node.type.name !== 'paragraph') {
+      return node.type.name;
+    }
+  }
+  return 'unknown';
+};
+export var linkObjectFromNode = function linkObjectFromNode(doc, schema, node, pos) {
+  var nodeContext = getLinkNodeContext(doc, pos);
   if (isLinkNode(node)) {
     return {
       type: 'node',
       pos: pos,
-      node: node
+      node: node,
+      nodeContext: nodeContext
     };
   }
   if (node.marks) {
@@ -99,7 +116,8 @@ export var linkObjectFromNode = function linkObjectFromNode(schema, node, pos) {
         return {
           type: 'mark',
           pos: pos,
-          mark: mark
+          mark: mark,
+          nodeContext: nodeContext
         };
       }
     }
@@ -114,11 +132,29 @@ export var findLinksAtPositions = function findLinksAtPositions(tr, positions) {
     if (!node) {
       continue;
     }
-    var link = linkObjectFromNode(schema, node, pos);
+    var link = linkObjectFromNode(tr.doc, schema, node, pos);
     if (!link) {
       continue;
     }
     links.push(link);
   }
   return links;
+};
+
+/**
+ * Returns whether or not two sets of links appear to likely be the same set of links
+ * That they are in the same order and that both their hrefs and appearances match
+ */
+export var areSameLinks = function areSameLinks(linksA, linksB) {
+  if (linksA.length !== linksB.length) {
+    return false;
+  }
+  for (var i = 0; i < linksA.length; i++) {
+    var linkA = linksA[i];
+    var linkB = linksB[i];
+    if (getLinkUrl(linkA) !== getLinkUrl(linkB) || appearanceForLink(linkA) !== appearanceForLink(linkB)) {
+      return false;
+    }
+  }
+  return true;
 };

package/dist/esm/plugins/card/pm-plugins/doc.js

@@ -6,12 +6,11 @@ import { NodeSelection, TextSelection } from 'prosemirror-state';
 import { closeHistory } from 'prosemirror-history';
 import { isSafeUrl } from '@atlaskit/adf-schema';
 import { addLinkMetadata } from '@atlaskit/editor-common/card';
-import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, addAnalytics, EVENT_TYPE, INPUT_METHOD } from '../../../plugins/analytics';
+import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { SMART_LINK_TYPE } from '../../../plugins/analytics/types/node-events';
-import { getLinkCreationAnalyticsEvent } from '../../../plugins/hyperlink/analytics';
 import { nodesBetweenChanged, processRawValue } from '../../../utils';
 import { unlinkPayload } from '../../../utils/linking-utils';
-import { isFromCurrentDomain } from '../../hyperlink/utils';
+import { isFromCurrentDomain, getLinkCreationAnalyticsEvent } from '@atlaskit/editor-common/utils';
 import { appearanceForNodeType, selectedCardAppearance } from '../utils';
 import { queueCards, resolveCard } from './actions';
 import { pluginKey } from './plugin-key';
@@ -47,7 +46,7 @@ function replaceLinksToCards(tr, cardAdf, schema, request) {
   tr.replaceWith(pos, pos + (node.text || url).length, nodes);
   return $pos.node($pos.depth - 1).type.name;
 }
-export var replaceQueuedUrlWithCard = function replaceQueuedUrlWithCard(url, cardData, analyticsAction) {
+export var replaceQueuedUrlWithCard = function replaceQueuedUrlWithCard(url, cardData, analyticsAction, editorAnalyticsApi) {
   return function (editorState, dispatch) {
     var state = pluginKey.getState(editorState);
     if (!state) {
@@ -94,7 +93,7 @@ export var replaceQueuedUrlWithCard = function replaceQueuedUrlWithCard(url, car
          */
         var inputMethod = requests[0].source;
         var sourceEvent = requests[0].sourceEvent;
-        addAnalytics(editorState, tr, {
+        editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent({
           action: analyticsAction || ACTION.INSERTED,
           actionSubject: ACTION_SUBJECT.DOCUMENT,
           actionSubjectId: ACTION_SUBJECT_ID.SMART_LINK,
@@ -108,7 +107,7 @@ export var replaceQueuedUrlWithCard = function replaceQueuedUrlWithCard(url, car
           nonPrivacySafeAttributes: {
             domainName: domainName
           }
-        });
+        })(tr);
         addLinkMetadata(editorState.selection, tr, {
           action: analyticsAction,
           inputMethod: inputMethod,
@@ -123,7 +122,7 @@ export var replaceQueuedUrlWithCard = function replaceQueuedUrlWithCard(url, car
     return true;
   };
 };
-export var handleFallbackWithAnalytics = function handleFallbackWithAnalytics(request) {
+export var handleFallbackWithAnalytics = function handleFallbackWithAnalytics(request, editorAnalyticsApi) {
   return function (state, dispatch) {
     var cardState = pluginKey.getState(state);
     if (!cardState) {
@@ -131,7 +130,7 @@ export var handleFallbackWithAnalytics = function handleFallbackWithAnalytics(re
     }
     var tr = state.tr;
     if (request.source !== INPUT_METHOD.FLOATING_TB) {
-      addAnalytics(state, tr, getLinkCreationAnalyticsEvent(request.source, request.url));
+      editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent(getLinkCreationAnalyticsEvent(request.source, request.url))(tr);
     }
     addLinkMetadata(state.selection, tr, {
       action: request.analyticsAction,
@@ -242,7 +241,7 @@ export var convertHyperlinkToSmartCard = function convertHyperlinkToSmartCard(st
   });
   return queueCards(requests)(state.tr);
 };
-export var changeSelectedCardToLink = function changeSelectedCardToLink(text, href, sendAnalytics, node, pos) {
+export var changeSelectedCardToLink = function changeSelectedCardToLink(text, href, sendAnalytics, node, pos, editorAnalyticsApi) {
   return function (state, dispatch) {
     var tr;
     if (node && pos) {
@@ -253,7 +252,7 @@ export var changeSelectedCardToLink = function changeSelectedCardToLink(text, hr
     var selectedNode = state.selection instanceof NodeSelection && state.selection.node;
     if (sendAnalytics) {
       if (selectedNode) {
-        addAnalytics(state, tr, {
+        editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent({
           action: ACTION.CHANGED_TYPE,
           actionSubject: ACTION_SUBJECT.SMART_LINK,
           eventType: EVENT_TYPE.TRACK,
@@ -261,7 +260,7 @@ export var changeSelectedCardToLink = function changeSelectedCardToLink(text, hr
             newType: SMART_LINK_TYPE.URL,
             previousType: appearanceForNodeType(selectedNode.type)
           }
-        });
+        })(tr);
       }
     }
     if (dispatch) {
@@ -270,7 +269,7 @@ export var changeSelectedCardToLink = function changeSelectedCardToLink(text, hr
     return true;
   };
 };
-export var changeSelectedCardToLinkFallback = function changeSelectedCardToLinkFallback(text, href, sendAnalytics, node, pos) {
+export var changeSelectedCardToLinkFallback = function changeSelectedCardToLinkFallback(text, href, sendAnalytics, node, pos, editorAnalyticsApi) {
   return function (state, dispatch) {
     var tr;
     if (node && pos) {
@@ -279,14 +278,14 @@ export var changeSelectedCardToLinkFallback = function changeSelectedCardToLinkF
       tr = cardToLinkWithTransaction(state, text, href);
     }
     if (sendAnalytics) {
-      addAnalytics(state, tr, {
+      editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent({
         action: ACTION.ERRORED,
         actionSubject: ACTION_SUBJECT.SMART_LINK,
         eventType: EVENT_TYPE.OPERATIONAL,
         attributes: {
           error: 'Smart card falling back to link.'
         }
-      });
+      })(tr);
     }
     if (dispatch) {
       dispatch(tr.scrollIntoView());
@@ -328,7 +327,7 @@ function cardNodeToLinkWithTransaction(state, text, href, node, pos) {
     href: href || url
   })]));
 }
-export var changeSelectedCardToText = function changeSelectedCardToText(text) {
+export var changeSelectedCardToText = function changeSelectedCardToText(text, editorAnalyticsApi) {
   return function (state, dispatch) {
     var selectedNode = state.selection instanceof NodeSelection && state.selection.node;
     if (!selectedNode) {
@@ -339,13 +338,14 @@ export var changeSelectedCardToText = function changeSelectedCardToText(text) {
       addLinkMetadata(state.selection, tr, {
         action: ACTION.UNLINK
       });
-      addAnalytics(state, tr.scrollIntoView(), unlinkPayload(ACTION_SUBJECT_ID.CARD_INLINE));
+      tr.scrollIntoView();
+      editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent(unlinkPayload(ACTION_SUBJECT_ID.CARD_INLINE))(tr);
       dispatch(tr);
     }
     return true;
   };
 };
-export var setSelectedCardAppearance = function setSelectedCardAppearance(appearance) {
+export var setSelectedCardAppearance = function setSelectedCardAppearance(appearance, editorAnalyticsApi) {
   return function (state, dispatch) {
     var _previousNode$type;
     var selectedNode = state.selection instanceof NodeSelection && state.selection.node;
@@ -384,7 +384,7 @@ export var setSelectedCardAppearance = function setSelectedCardAppearance(appear
     if ((previousNode === null || previousNode === void 0 ? void 0 : (_previousNode$type = previousNode.type) === null || _previousNode$type === void 0 ? void 0 : _previousNode$type.name) === 'paragraph') {
       tr.delete(previousNodePos, from);
     }
-    addAnalytics(state, tr, {
+    editorAnalyticsApi === null || editorAnalyticsApi === void 0 ? void 0 : editorAnalyticsApi.attachAnalyticsEvent({
       action: ACTION.CHANGED_TYPE,
       actionSubject: ACTION_SUBJECT.SMART_LINK,
       eventType: EVENT_TYPE.TRACK,
@@ -392,7 +392,7 @@ export var setSelectedCardAppearance = function setSelectedCardAppearance(appear
         newType: appearance,
         previousType: appearanceForNodeType(selectedNode.type)
       }
-    });
+    })(tr);
     addLinkMetadata(state.selection, tr, {
       action: ACTION.CHANGED_TYPE
     });

package/dist/esm/plugins/card/pm-plugins/main.js

@@ -11,7 +11,7 @@ import { handleProvider, resolveWithProvider } from './util/resolve';
 import { getNewRequests, getPluginState, getPluginStateWithUpdatedPos } from './util/state';
 import { createAnalyticsQueue, eventsFromTransaction } from './analytics';
 export { pluginKey } from './plugin-key';
-export var createPlugin = function createPlugin(options) {
+export var createPlugin = function createPlugin(options, pluginInjectionApi) {
   return function (pmPluginFactoryParams) {
     var lpAnalyticsEventsNext = pmPluginFactoryParams.featureFlags.lpAnalyticsEventsNext;
     var analyticsQueue = createAnalyticsQueue(!!lpAnalyticsEventsNext);
@@ -81,7 +81,8 @@ export var createPlugin = function createPlugin(options) {
                  * other tasks as per common implementations of the JavaScript event loop in browsers.
                  */
                 var invoke = rafSchedule(function () {
-                  return resolveWithProvider(view, provider, request, options);
+                  var _pluginInjectionApi$d;
+                  return resolveWithProvider(view, provider, request, options, pluginInjectionApi === null || pluginInjectionApi === void 0 ? void 0 : (_pluginInjectionApi$d = pluginInjectionApi.dependencies.analytics) === null || _pluginInjectionApi$d === void 0 ? void 0 : _pluginInjectionApi$d.actions);
                 });
                 rafCancellationCallbacks.push(invoke.cancel);
                 invoke();
@@ -127,7 +128,8 @@ export var createPlugin = function createPlugin(options) {
               allowResizing: allowResizing,
               platform: platform,
               fullWidthMode: fullWidthMode,
-              dispatchAnalyticsEvent: dispatchAnalyticsEvent
+              dispatchAnalyticsEvent: dispatchAnalyticsEvent,
+              pluginInjectionApi: pluginInjectionApi
             };
             var hasIntlContext = true;
             return new EmbedCard(node, view, getPos, portalProviderAPI, eventDispatcher, reactComponentProps, undefined, true, undefined, hasIntlContext).init();

package/dist/esm/plugins/card/pm-plugins/shouldReplaceLink.js

@@ -1,5 +1,5 @@
 import { normalizeUrl } from '@atlaskit/adf-schema';
-import { md } from '../../paste/md';
+import { md } from '@atlaskit/editor-common/paste';
 export function shouldReplaceLink(node) {
   var compareLinkText = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
   var compareToUrl = arguments.length > 2 ? arguments[2] : undefined;

package/dist/esm/plugins/card/pm-plugins/util/resolve.js

@@ -5,14 +5,14 @@ import { replaceQueuedUrlWithCard, handleFallbackWithAnalytics } from '../doc';
 // ============================================================================ //
 // Used for all interactions with the EditorCardProvider.
 // ============================================================================ //
-export var resolveWithProvider = function resolveWithProvider(view, provider, request, options) {
+export var resolveWithProvider = function resolveWithProvider(view, provider, request, options, editorAnalyticsApi) {
   // When user manually changes appearance from blue link to smart link, we should respect that,
   var shouldForceAppearance =
   // This flag is set to true only in one place atm:
   // packages/editor/editor-core/src/plugins/card/pm-plugins/doc.ts @ convertHyperlinkToSmartCard
   // Which is used when user switching from URL to smart link appearance.
   !!request.shouldReplaceLink;
-  var handleResolve = provider.resolve(request.url, request.appearance, shouldForceAppearance).then(handleResolved(view, request, options), handleRejected(view, request));
+  var handleResolve = provider.resolve(request.url, request.appearance, shouldForceAppearance).then(handleResolved(view, request, editorAnalyticsApi, options), handleRejected(view, request, editorAnalyticsApi));
   return handleResolve;
 };
 var updateCardType = function updateCardType(resolvedCard, options) {
@@ -24,16 +24,16 @@ var updateCardType = function updateCardType(resolvedCard, options) {
     resolvedCard.type = 'inlineCard';
   }
 };
-var handleResolved = function handleResolved(view, request, options) {
+var handleResolved = function handleResolved(view, request, editorAnalyticsApi, options) {
   return function (resolvedCard) {
     updateCardType(resolvedCard, options);
-    replaceQueuedUrlWithCard(request.url, resolvedCard, request.analyticsAction)(view.state, view.dispatch);
+    replaceQueuedUrlWithCard(request.url, resolvedCard, request.analyticsAction, editorAnalyticsApi)(view.state, view.dispatch);
     return resolvedCard;
   };
 };
-var handleRejected = function handleRejected(view, request) {
+var handleRejected = function handleRejected(view, request, editorAnalyticsApi) {
   return function () {
-    handleFallbackWithAnalytics(request)(view.state, view.dispatch);
+    handleFallbackWithAnalytics(request, editorAnalyticsApi)(view.state, view.dispatch);
   };
 };