@atlaskit/editor-plugin-analytics 0.0.1

package/CHANGELOG.md

@@ -0,0 +1 @@
+# @atlaskit/editor-plugin-analytics

package/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2023 Atlassian Pty Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,7 @@
+# EditorPluginAnalytics
+
+Analytics plugin for @atlaskit/editor-core
+
+## Usage
+
+`import { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';`

package/dist/cjs/analytics-api/attach-payload-into-transaction.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createAttachPayloadIntoTransaction = exports.attachPayloadIntoTransaction = void 0;
+var _steps = require("@atlaskit/adf-schema/steps");
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _editorStateContext = require("./editor-state-context");
+var _mapAttributes = require("./map-attributes");
+var actionsToIgnore = [_analytics.ACTION.INVOKED, _analytics.ACTION.OPENED];
+var createAttachPayloadIntoTransaction = function createAttachPayloadIntoTransaction(selection) {
+  return function (_ref) {
+    var payload = _ref.payload,
+      tr = _ref.tr,
+      channel = _ref.channel;
+    return attachPayloadIntoTransaction({
+      payload: payload,
+      selection: selection,
+      tr: tr,
+      channel: channel
+    });
+  };
+};
+
+// This utils was taken as reference in packages/editor/editor-plugin-ai/src/analytics/utils.ts
+//  to create new util attachPayloadIntoTransaction in above file.
+// If you make a change here, please review attachPayloadIntoTransaction in above
+//  file and update it as well if needed.
+exports.createAttachPayloadIntoTransaction = createAttachPayloadIntoTransaction;
+var attachPayloadIntoTransaction = function attachPayloadIntoTransaction(_ref2) {
+  var payload = _ref2.payload,
+    selection = _ref2.selection,
+    tr = _ref2.tr,
+    channel = _ref2.channel;
+  payload = (0, _editorStateContext.getStateContext)(selection, payload);
+  payload = (0, _mapAttributes.mapActionSubjectIdToAttributes)(payload);
+  var storedMarks = tr.storedMarks;
+  var pos = tr.mapping.map(selection.$from.pos, -1);
+  tr.step(new _steps.AnalyticsStep([{
+    payload: payload,
+    channel: channel
+  }], actionsToIgnore, pos) // We need to create the step based on a position, this prevent split history for relative changes.
+  );
+
+  // When you add a new step all the storedMarks are removed it
+  if (storedMarks) {
+    tr.setStoredMarks(storedMarks);
+  }
+};
+exports.attachPayloadIntoTransaction = attachPayloadIntoTransaction;

package/dist/cjs/analytics-api/editor-state-context.js

@@ -0,0 +1,78 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.findInsertLocation = findInsertLocation;
+exports.getSelectionType = getSelectionType;
+exports.getStateContext = getStateContext;
+var _prosemirrorState = require("prosemirror-state");
+var _prosemirrorUtils = require("prosemirror-utils");
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _cellSelection = require("@atlaskit/editor-tables/cell-selection");
+function getSelectionType(selection) {
+  var _selection$constructo;
+  var type;
+  var position;
+  if ((selection === null || selection === void 0 ? void 0 : (_selection$constructo = selection.constructor) === null || _selection$constructo === void 0 ? void 0 : _selection$constructo.name) === 'GapCursorSelection') {
+    type = _analytics.SELECTION_TYPE.GAP_CURSOR;
+    position = selection.side;
+  } else if (selection instanceof _cellSelection.CellSelection) {
+    type = _analytics.SELECTION_TYPE.CELL;
+  } else if (selection instanceof _prosemirrorState.NodeSelection) {
+    type = _analytics.SELECTION_TYPE.NODE;
+  } else if (selection.from !== selection.to) {
+    type = _analytics.SELECTION_TYPE.RANGED;
+  } else {
+    type = _analytics.SELECTION_TYPE.CURSOR;
+    var from = selection.from,
+      $from = selection.$from;
+    if (from === $from.start()) {
+      position = _analytics.SELECTION_POSITION.START;
+    } else if (from === $from.end()) {
+      position = _analytics.SELECTION_POSITION.END;
+    } else {
+      position = _analytics.SELECTION_POSITION.MIDDLE;
+    }
+  }
+  return {
+    type: type,
+    position: position
+  };
+}
+function findInsertLocation(selection) {
+  var _selection$$from$doc$ = selection.$from.doc.type,
+    schema = _selection$$from$doc$.schema,
+    name = _selection$$from$doc$.name;
+  if (selection instanceof _prosemirrorState.NodeSelection) {
+    return selection.node.type.name;
+  }
+  if (selection instanceof _cellSelection.CellSelection) {
+    return schema.nodes.table.name;
+  }
+
+  // Text selection
+  var parentNodeInfo = (0, _prosemirrorUtils.findParentNode)(function (node) {
+    return node.type !== schema.nodes.paragraph;
+  })(selection);
+  return parentNodeInfo ? parentNodeInfo.node.type.name : name;
+}
+function getStateContext(selection, payload) {
+  if (!payload.attributes) {
+    return payload;
+  }
+  var _getSelectionType = getSelectionType(selection),
+    type = _getSelectionType.type,
+    position = _getSelectionType.position;
+  payload.attributes.selectionType = type;
+  if (position) {
+    payload.attributes.selectionPosition = position;
+  }
+  var insertLocation = findInsertLocation(selection);
+  if (payload.action === _analytics.ACTION.INSERTED && payload.actionSubject === _analytics.ACTION_SUBJECT.DOCUMENT && payload.attributes) {
+    payload.attributes.insertLocation = insertLocation;
+  } else {
+    payload.attributes.nodeLocation = insertLocation;
+  }
+  return payload;
+}

package/dist/cjs/analytics-api/map-attributes.js

@@ -0,0 +1,23 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.mapActionSubjectIdToAttributes = mapActionSubjectIdToAttributes;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _analytics = require("@atlaskit/editor-common/analytics");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+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) { (0, _defineProperty2.default)(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; }
+function mapActionSubjectIdToAttributes(payload) {
+  var documentInserted = payload.action === _analytics.ACTION.INSERTED && payload.actionSubject === _analytics.ACTION_SUBJECT.DOCUMENT;
+  var textFormatted = payload.action === _analytics.ACTION.FORMATTED && payload.actionSubject === _analytics.ACTION_SUBJECT.TEXT;
+  var hasActionSubjectId = !!payload.actionSubjectId;
+  if (hasActionSubjectId && (documentInserted || textFormatted)) {
+    payload.attributes = _objectSpread(_objectSpread({}, payload.attributes), {}, {
+      // @ts-expect-error
+      actionSubjectId: payload.actionSubjectId
+    });
+  }
+  return payload;
+}

package/dist/cjs/consts.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.editorAnalyticsChannel = exports.analyticsEventKey = void 0;
+var _analyticsListeners = require("@atlaskit/analytics-listeners");
+var _utils = require("@atlaskit/editor-common/utils");
+var analyticsEventKey = _utils.analyticsEventKey;
+exports.analyticsEventKey = analyticsEventKey;
+var editorAnalyticsChannel = _analyticsListeners.FabricChannel.editor;
+exports.editorAnalyticsChannel = editorAnalyticsChannel;

package/dist/cjs/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "analyticsPlugin", {
+  enumerable: true,
+  get: function get() {
+    return _plugin.analyticsPlugin;
+  }
+});
+var _plugin = require("./plugin");

package/dist/cjs/plugin-key.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.analyticsPluginKey = void 0;
+var _prosemirrorState = require("prosemirror-state");
+var analyticsPluginKey = new _prosemirrorState.PluginKey('analyticsPlugin');
+exports.analyticsPluginKey = analyticsPluginKey;

package/dist/cjs/plugin.js

@@ -0,0 +1,187 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.analyticsPlugin = void 0;
+exports.extendPayload = extendPayload;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _steps = require("@atlaskit/adf-schema/steps");
+var _analyticsListeners = require("@atlaskit/analytics-listeners");
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _utils = require("@atlaskit/editor-common/utils");
+var _attachPayloadIntoTransaction = require("./analytics-api/attach-payload-into-transaction");
+var _pluginKey = require("./plugin-key");
+var _undoRedoInputSource = require("./undo-redo-input-source");
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+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) { (0, _defineProperty2.default)(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; }
+function createPlugin(options, featureFlags) {
+  if (!options || !options.createAnalyticsEvent) {
+    return;
+  }
+  var hasRequiredPerformanceAPIs = (0, _utils.isPerformanceAPIAvailable)();
+  return new _safePlugin.SafePlugin({
+    key: _pluginKey.analyticsPluginKey,
+    state: {
+      init: function init() {
+        return _objectSpread(_objectSpread({}, options), {}, {
+          fireAnalytics: (0, _analytics.fireAnalyticsEvent)(options.createAnalyticsEvent)
+        });
+      },
+      apply: function apply(tr, pluginState, _, state) {
+        if (pluginState.createAnalyticsEvent !== options.createAnalyticsEvent) {
+          // When the plugin state is reconfigured, the init function isn't called again
+          return _objectSpread(_objectSpread({}, pluginState), {}, {
+            createAnalyticsEvent: options.createAnalyticsEvent
+          });
+        }
+        if (featureFlags.catchAllTracking) {
+          var analyticsEventWithChannel = (0, _analytics.getAnalyticsEventsFromTransaction)(tr);
+          if (analyticsEventWithChannel.length > 0) {
+            var _iterator = _createForOfIteratorHelper(analyticsEventWithChannel),
+              _step;
+            try {
+              var _loop = function _loop() {
+                var _step$value = _step.value,
+                  payload = _step$value.payload,
+                  channel = _step$value.channel;
+                // Measures how much time it takes to update the DOM after each ProseMirror document update
+                // that has an analytics event.
+                if (hasRequiredPerformanceAPIs && tr.docChanged && payload.action !== _analytics.ACTION.INSERTED && payload.action !== _analytics.ACTION.DELETED) {
+                  var measureName = "".concat(payload.actionSubject, ":").concat(payload.action, ":").concat(payload.actionSubjectId);
+                  (0, _utils.measureRender)(
+                  // NOTE this name could be resulting in misleading data -- where if multiple payloads are
+                  // received before a render completes -- the measurement value will be inaccurate (this is
+                  // due to measureRender requiring unique measureNames)
+                  measureName, function (_ref) {
+                    var duration = _ref.duration,
+                      distortedDuration = _ref.distortedDuration;
+                    (0, _analytics.fireAnalyticsEvent)(pluginState.createAnalyticsEvent)({
+                      payload: extendPayload({
+                        payload: payload,
+                        duration: duration,
+                        distortedDuration: distortedDuration
+                      }),
+                      channel: channel
+                    });
+                  });
+                }
+              };
+              for (_iterator.s(); !(_step = _iterator.n()).done;) {
+                _loop();
+              }
+            } catch (err) {
+              _iterator.e(err);
+            } finally {
+              _iterator.f();
+            }
+          }
+        }
+        return pluginState;
+      }
+    }
+  });
+}
+var analyticsPlugin = function analyticsPlugin(options, api) {
+  var _api$dependencies$fea;
+  var featureFlags = (api === null || api === void 0 ? void 0 : (_api$dependencies$fea = api.dependencies.featureFlags) === null || _api$dependencies$fea === void 0 ? void 0 : _api$dependencies$fea.sharedState.currentState()) || {};
+  return {
+    name: 'analytics',
+    getSharedState: function getSharedState(editorState) {
+      var _analyticsPluginKey$g;
+      if (!editorState) {
+        return {
+          createAnalyticsEvent: null,
+          attachAnalyticsEvent: null
+        };
+      }
+      var _ref2 = (_analyticsPluginKey$g = _pluginKey.analyticsPluginKey.getState(editorState)) !== null && _analyticsPluginKey$g !== void 0 ? _analyticsPluginKey$g : {},
+        createAnalyticsEvent = _ref2.createAnalyticsEvent;
+      return {
+        createAnalyticsEvent: createAnalyticsEvent,
+        attachAnalyticsEvent: (0, _attachPayloadIntoTransaction.createAttachPayloadIntoTransaction)(editorState.selection)
+      };
+    },
+    actions: {
+      attachAnalyticsEvent: function attachAnalyticsEvent(payload) {
+        var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _analyticsListeners.FabricChannel.editor;
+        return function (tr) {
+          var _api$dependencies$ana, _api$dependencies$ana2;
+          var _ref3 = (_api$dependencies$ana = api === null || api === void 0 ? void 0 : (_api$dependencies$ana2 = api.dependencies.analytics) === null || _api$dependencies$ana2 === void 0 ? void 0 : _api$dependencies$ana2.sharedState.currentState()) !== null && _api$dependencies$ana !== void 0 ? _api$dependencies$ana : {},
+            createAnalyticsEvent = _ref3.createAnalyticsEvent,
+            attachAnalyticsEvent = _ref3.attachAnalyticsEvent;
+          if (!tr || !createAnalyticsEvent || !attachAnalyticsEvent) {
+            return false;
+          }
+          attachAnalyticsEvent({
+            tr: tr,
+            payload: payload,
+            channel: channel
+          });
+          return true;
+        };
+      }
+    },
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'analyticsPlugin',
+        plugin: function plugin() {
+          return createPlugin(options, featureFlags);
+        }
+      }];
+    },
+    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref4) {
+      var originalTransaction = _ref4.originalTransaction,
+        transactions = _ref4.transactions,
+        newEditorState = _ref4.newEditorState;
+      var pluginState = _pluginKey.analyticsPluginKey.getState(newEditorState);
+      if (!pluginState || !pluginState.createAnalyticsEvent) {
+        return;
+      }
+      var steps = transactions.reduce(function (acc, tr) {
+        var payloads = tr.steps.filter(function (step) {
+          return step instanceof _steps.AnalyticsStep;
+        }).map(function (x) {
+          return x.analyticsEvents;
+        }).reduce(function (acc, val) {
+          return acc.concat(val);
+        }, []);
+        acc.push.apply(acc, (0, _toConsumableArray2.default)(payloads));
+        return acc;
+      }, []);
+      if (steps.length === 0) {
+        return;
+      }
+      var createAnalyticsEvent = pluginState.createAnalyticsEvent;
+      var undoAnaltyicsEventTransformer = (0, _undoRedoInputSource.generateUndoRedoInputSoucePayload)(originalTransaction);
+      steps.forEach(function (_ref5) {
+        var payload = _ref5.payload,
+          channel = _ref5.channel;
+        var nextPayload = undoAnaltyicsEventTransformer(payload);
+        (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent)({
+          payload: nextPayload,
+          channel: channel
+        });
+      });
+    }
+  };
+};
+exports.analyticsPlugin = analyticsPlugin;
+function extendPayload(_ref6) {
+  var payload = _ref6.payload,
+    duration = _ref6.duration,
+    distortedDuration = _ref6.distortedDuration;
+  return _objectSpread(_objectSpread({}, payload), {}, {
+    attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
+      duration: duration,
+      distortedDuration: distortedDuration
+    }),
+    eventType: _analytics.EVENT_TYPE.OPERATIONAL
+  });
+}

package/dist/cjs/undo-redo-input-source.js

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateUndoRedoInputSoucePayload = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+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) { (0, _defineProperty2.default)(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; }
+var getUndoRedoInputSource = function getUndoRedoInputSource(tr) {
+  var _tr$getMeta;
+  // TODO: Please, do not copy or use this kind of code below
+  return (_tr$getMeta = tr.getMeta('undoRedoPlugin$')) !== null && _tr$getMeta !== void 0 ? _tr$getMeta : null;
+};
+var generateUndoRedoInputSoucePayload = function generateUndoRedoInputSoucePayload(tr) {
+  var undoRedoPluginInputSource = getUndoRedoInputSource(tr);
+  return function (payload) {
+    var shouldAddHistoryTriggerMethodAttribute = undoRedoPluginInputSource && ['undid', 'redid'].includes(payload.action);
+    return !shouldAddHistoryTriggerMethodAttribute ? payload : _objectSpread(_objectSpread({}, payload), {}, {
+      attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
+        historyTriggerMethod: undoRedoPluginInputSource
+      })
+    });
+  };
+};
+exports.generateUndoRedoInputSoucePayload = generateUndoRedoInputSoucePayload;

package/dist/cjs/version.json

@@ -0,0 +1,5 @@
+{
+	"name": "@atlaskit/editor-plugin-analytics",
+	"version": "0.0.1",
+	"sideEffects": false
+}

package/dist/es2019/analytics-api/attach-payload-into-transaction.js

@@ -0,0 +1,43 @@
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
+import { ACTION } from '@atlaskit/editor-common/analytics';
+import { getStateContext } from './editor-state-context';
+import { mapActionSubjectIdToAttributes } from './map-attributes';
+const actionsToIgnore = [ACTION.INVOKED, ACTION.OPENED];
+export const createAttachPayloadIntoTransaction = selection => ({
+  payload,
+  tr,
+  channel
+}) => attachPayloadIntoTransaction({
+  payload,
+  selection,
+  tr,
+  channel
+});
+
+// This utils was taken as reference in packages/editor/editor-plugin-ai/src/analytics/utils.ts
+//  to create new util attachPayloadIntoTransaction in above file.
+// If you make a change here, please review attachPayloadIntoTransaction in above
+//  file and update it as well if needed.
+export const attachPayloadIntoTransaction = ({
+  payload,
+  selection,
+  tr,
+  channel
+}) => {
+  payload = getStateContext(selection, payload);
+  payload = mapActionSubjectIdToAttributes(payload);
+  const {
+    storedMarks
+  } = tr;
+  const pos = tr.mapping.map(selection.$from.pos, -1);
+  tr.step(new AnalyticsStep([{
+    payload,
+    channel
+  }], actionsToIgnore, pos) // We need to create the step based on a position, this prevent split history for relative changes.
+  );
+
+  // When you add a new step all the storedMarks are removed it
+  if (storedMarks) {
+    tr.setStoredMarks(storedMarks);
+  }
+};

package/dist/es2019/analytics-api/editor-state-context.js

@@ -0,0 +1,72 @@
+import { NodeSelection } from 'prosemirror-state';
+import { findParentNode } from 'prosemirror-utils';
+import { ACTION, ACTION_SUBJECT, SELECTION_POSITION, SELECTION_TYPE } from '@atlaskit/editor-common/analytics';
+import { CellSelection } from '@atlaskit/editor-tables/cell-selection';
+export function getSelectionType(selection) {
+  var _selection$constructo;
+  let type;
+  let position;
+  if ((selection === null || selection === void 0 ? void 0 : (_selection$constructo = selection.constructor) === null || _selection$constructo === void 0 ? void 0 : _selection$constructo.name) === 'GapCursorSelection') {
+    type = SELECTION_TYPE.GAP_CURSOR;
+    position = selection.side;
+  } else if (selection instanceof CellSelection) {
+    type = SELECTION_TYPE.CELL;
+  } else if (selection instanceof NodeSelection) {
+    type = SELECTION_TYPE.NODE;
+  } else if (selection.from !== selection.to) {
+    type = SELECTION_TYPE.RANGED;
+  } else {
+    type = SELECTION_TYPE.CURSOR;
+    const {
+      from,
+      $from
+    } = selection;
+    if (from === $from.start()) {
+      position = SELECTION_POSITION.START;
+    } else if (from === $from.end()) {
+      position = SELECTION_POSITION.END;
+    } else {
+      position = SELECTION_POSITION.MIDDLE;
+    }
+  }
+  return {
+    type,
+    position
+  };
+}
+export function findInsertLocation(selection) {
+  const {
+    schema,
+    name
+  } = selection.$from.doc.type;
+  if (selection instanceof NodeSelection) {
+    return selection.node.type.name;
+  }
+  if (selection instanceof CellSelection) {
+    return schema.nodes.table.name;
+  }
+
+  // Text selection
+  const parentNodeInfo = findParentNode(node => node.type !== schema.nodes.paragraph)(selection);
+  return parentNodeInfo ? parentNodeInfo.node.type.name : name;
+}
+export function getStateContext(selection, payload) {
+  if (!payload.attributes) {
+    return payload;
+  }
+  const {
+    type,
+    position
+  } = getSelectionType(selection);
+  payload.attributes.selectionType = type;
+  if (position) {
+    payload.attributes.selectionPosition = position;
+  }
+  const insertLocation = findInsertLocation(selection);
+  if (payload.action === ACTION.INSERTED && payload.actionSubject === ACTION_SUBJECT.DOCUMENT && payload.attributes) {
+    payload.attributes.insertLocation = insertLocation;
+  } else {
+    payload.attributes.nodeLocation = insertLocation;
+  }
+  return payload;
+}

package/dist/es2019/analytics-api/map-attributes.js

@@ -0,0 +1,14 @@
+import { ACTION, ACTION_SUBJECT } from '@atlaskit/editor-common/analytics';
+export function mapActionSubjectIdToAttributes(payload) {
+  const documentInserted = payload.action === ACTION.INSERTED && payload.actionSubject === ACTION_SUBJECT.DOCUMENT;
+  const textFormatted = payload.action === ACTION.FORMATTED && payload.actionSubject === ACTION_SUBJECT.TEXT;
+  const hasActionSubjectId = !!payload.actionSubjectId;
+  if (hasActionSubjectId && (documentInserted || textFormatted)) {
+    payload.attributes = {
+      ...payload.attributes,
+      // @ts-expect-error
+      actionSubjectId: payload.actionSubjectId
+    };
+  }
+  return payload;
+}

package/dist/es2019/consts.js

@@ -0,0 +1,4 @@
+import { FabricChannel } from '@atlaskit/analytics-listeners';
+import { analyticsEventKey as key } from '@atlaskit/editor-common/utils';
+export const analyticsEventKey = key;
+export const editorAnalyticsChannel = FabricChannel.editor;

package/dist/es2019/index.js

@@ -0,0 +1 @@
+export { analyticsPlugin } from './plugin';

package/dist/es2019/plugin-key.js

@@ -0,0 +1,2 @@
+import { PluginKey } from 'prosemirror-state';
+export const analyticsPluginKey = new PluginKey('analyticsPlugin');