@atlaskit/editor-plugin-analytics 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-analytics
 
+## 1.0.2
+
+### Patch Changes
+
+- Updated dependencies
+
+## 1.0.1
+
+### Patch Changes
+
+- [#72295](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/72295) [`eefc8788ab31`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/eefc8788ab31) - ED-22046 Add insertedLocation attribute for analytics in node insertion
+- Updated dependencies
+
 ## 1.0.0
 
 ### Major Changes

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

@@ -32,7 +32,7 @@ var attachPayloadIntoTransaction = exports.attachPayloadIntoTransaction = functi
     selection = _ref2.selection,
     tr = _ref2.tr,
     channel = _ref2.channel;
-  payload = (0, _editorStateContext.getStateContext)(selection, payload);
+  payload = (0, _editorStateContext.getStateContext)(selection, payload, tr);
   payload = (0, _mapAttributes.mapActionSubjectIdToAttributes)(payload);
   var storedMarks = tr.storedMarks;
   var pos = tr.mapping.map(selection.$from.pos, -1);

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

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.findInsertLocation = findInsertLocation;
+exports.findInsertedLocation = findInsertedLocation;
 exports.getSelectionType = getSelectionType;
 exports.getStateContext = getStateContext;
 var _analytics = require("@atlaskit/editor-common/analytics");
@@ -57,7 +58,26 @@ function findInsertLocation(selection) {
   })(selection);
   return parentNodeInfo ? parentNodeInfo.node.type.name : name;
 }
-function getStateContext(selection, payload) {
+function findInsertedLocation(oldSelection, newSelection) {
+  var schema = newSelection.$from.doc.type.schema;
+  var _schema$nodes = schema.nodes,
+    paragraph = _schema$nodes.paragraph,
+    table = _schema$nodes.table;
+  if (oldSelection instanceof _cellSelection.CellSelection) {
+    return table.name;
+  }
+  var insertLocationInfo = (0, _utils.findParentNode)(function (node) {
+    return node.type !== paragraph;
+  })(oldSelection);
+  var parentNodePos = newSelection.$from.doc.resolve((insertLocationInfo === null || insertLocationInfo === void 0 ? void 0 : insertLocationInfo.start) || 0);
+
+  // Keep going one level above the attempted insert position till we find a node that contains the current cursor position in it's range
+  while (parentNodePos.end() < newSelection.$from.pos) {
+    parentNodePos = newSelection.$from.doc.resolve(parentNodePos.start(Math.max(parentNodePos.depth - 1, 0)));
+  }
+  return parentNodePos.node().type.name;
+}
+function getStateContext(selection, payload, tr) {
   if (!payload.attributes) {
     return payload;
   }
@@ -69,6 +89,9 @@ function getStateContext(selection, payload) {
     payload.attributes.selectionPosition = position;
   }
   var insertLocation = findInsertLocation(selection);
+  if (payload.action === _analytics.ACTION.INSERTED && payload.actionSubject !== _analytics.ACTION_SUBJECT.ANNOTATION) {
+    payload.attributes.insertedLocation = findInsertedLocation(selection, tr.selection);
+  }
   if (payload.action === _analytics.ACTION.INSERTED && payload.actionSubject === _analytics.ACTION_SUBJECT.DOCUMENT && payload.attributes) {
     payload.attributes.insertLocation = insertLocation;
   } else {

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

@@ -24,7 +24,7 @@ export const attachPayloadIntoTransaction = ({
   tr,
   channel
 }) => {
-  payload = getStateContext(selection, payload);
+  payload = getStateContext(selection, payload, tr);
   payload = mapActionSubjectIdToAttributes(payload);
   const {
     storedMarks

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

@@ -50,7 +50,29 @@ export function findInsertLocation(selection) {
   const parentNodeInfo = findParentNode(node => node.type !== schema.nodes.paragraph)(selection);
   return parentNodeInfo ? parentNodeInfo.node.type.name : name;
 }
-export function getStateContext(selection, payload) {
+export function findInsertedLocation(oldSelection, newSelection) {
+  const {
+    schema
+  } = newSelection.$from.doc.type;
+  const {
+    nodes: {
+      paragraph,
+      table
+    }
+  } = schema;
+  if (oldSelection instanceof CellSelection) {
+    return table.name;
+  }
+  const insertLocationInfo = findParentNode(node => node.type !== paragraph)(oldSelection);
+  let parentNodePos = newSelection.$from.doc.resolve((insertLocationInfo === null || insertLocationInfo === void 0 ? void 0 : insertLocationInfo.start) || 0);
+
+  // Keep going one level above the attempted insert position till we find a node that contains the current cursor position in it's range
+  while (parentNodePos.end() < newSelection.$from.pos) {
+    parentNodePos = newSelection.$from.doc.resolve(parentNodePos.start(Math.max(parentNodePos.depth - 1, 0)));
+  }
+  return parentNodePos.node().type.name;
+}
+export function getStateContext(selection, payload, tr) {
   if (!payload.attributes) {
     return payload;
   }
@@ -63,6 +85,9 @@ export function getStateContext(selection, payload) {
     payload.attributes.selectionPosition = position;
   }
   const insertLocation = findInsertLocation(selection);
+  if (payload.action === ACTION.INSERTED && payload.actionSubject !== ACTION_SUBJECT.ANNOTATION) {
+    payload.attributes.insertedLocation = findInsertedLocation(selection, tr.selection);
+  }
   if (payload.action === ACTION.INSERTED && payload.actionSubject === ACTION_SUBJECT.DOCUMENT && payload.attributes) {
     payload.attributes.insertLocation = insertLocation;
   } else {

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

@@ -26,7 +26,7 @@ export var attachPayloadIntoTransaction = function attachPayloadIntoTransaction(
     selection = _ref2.selection,
     tr = _ref2.tr,
     channel = _ref2.channel;
-  payload = getStateContext(selection, payload);
+  payload = getStateContext(selection, payload, tr);
   payload = mapActionSubjectIdToAttributes(payload);
   var storedMarks = tr.storedMarks;
   var pos = tr.mapping.map(selection.$from.pos, -1);

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

@@ -49,7 +49,26 @@ export function findInsertLocation(selection) {
   })(selection);
   return parentNodeInfo ? parentNodeInfo.node.type.name : name;
 }
-export function getStateContext(selection, payload) {
+export function findInsertedLocation(oldSelection, newSelection) {
+  var schema = newSelection.$from.doc.type.schema;
+  var _schema$nodes = schema.nodes,
+    paragraph = _schema$nodes.paragraph,
+    table = _schema$nodes.table;
+  if (oldSelection instanceof CellSelection) {
+    return table.name;
+  }
+  var insertLocationInfo = findParentNode(function (node) {
+    return node.type !== paragraph;
+  })(oldSelection);
+  var parentNodePos = newSelection.$from.doc.resolve((insertLocationInfo === null || insertLocationInfo === void 0 ? void 0 : insertLocationInfo.start) || 0);
+
+  // Keep going one level above the attempted insert position till we find a node that contains the current cursor position in it's range
+  while (parentNodePos.end() < newSelection.$from.pos) {
+    parentNodePos = newSelection.$from.doc.resolve(parentNodePos.start(Math.max(parentNodePos.depth - 1, 0)));
+  }
+  return parentNodePos.node().type.name;
+}
+export function getStateContext(selection, payload, tr) {
   if (!payload.attributes) {
     return payload;
   }
@@ -61,6 +80,9 @@ export function getStateContext(selection, payload) {
     payload.attributes.selectionPosition = position;
   }
   var insertLocation = findInsertLocation(selection);
+  if (payload.action === ACTION.INSERTED && payload.actionSubject !== ACTION_SUBJECT.ANNOTATION) {
+    payload.attributes.insertedLocation = findInsertedLocation(selection, tr.selection);
+  }
   if (payload.action === ACTION.INSERTED && payload.actionSubject === ACTION_SUBJECT.DOCUMENT && payload.attributes) {
     payload.attributes.insertLocation = insertLocation;
   } else {

package/dist/types/analytics-api/attach-payload-into-transaction.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
+import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 type AttachPayloadIntoTransaction = (props: {
     payload: AnalyticsEventPayload;

package/dist/types/analytics-api/editor-state-context.d.ts

@@ -1,9 +1,10 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import { SELECTION_POSITION, SELECTION_TYPE } from '@atlaskit/editor-common/analytics';
-import type { Selection } from '@atlaskit/editor-prosemirror/state';
+import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function getSelectionType(selection: Selection): {
     type: SELECTION_TYPE;
     position?: SELECTION_POSITION;
 };
 export declare function findInsertLocation(selection: Selection): string;
-export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload): AnalyticsEventPayload;
+export declare function findInsertedLocation(oldSelection: Selection, newSelection: Selection): string;
+export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload, tr: Transaction): AnalyticsEventPayload;

package/dist/types-ts4.5/analytics-api/attach-payload-into-transaction.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
+import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 type AttachPayloadIntoTransaction = (props: {
     payload: AnalyticsEventPayload;

package/dist/types-ts4.5/analytics-api/editor-state-context.d.ts

@@ -1,9 +1,10 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import { SELECTION_POSITION, SELECTION_TYPE } from '@atlaskit/editor-common/analytics';
-import type { Selection } from '@atlaskit/editor-prosemirror/state';
+import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function getSelectionType(selection: Selection): {
     type: SELECTION_TYPE;
     position?: SELECTION_POSITION;
 };
 export declare function findInsertLocation(selection: Selection): string;
-export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload): AnalyticsEventPayload;
+export declare function findInsertedLocation(oldSelection: Selection, newSelection: Selection): string;
+export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload, tr: Transaction): AnalyticsEventPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-analytics",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Analytics plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -35,7 +35,7 @@
     "@atlaskit/adf-schema": "^35.5.1",
     "@atlaskit/analytics-listeners": "^8.9.0",
     "@atlaskit/analytics-next": "^9.2.0",
-    "@atlaskit/editor-common": "^77.4.0",
+    "@atlaskit/editor-common": "^78.0.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
     "@atlaskit/editor-prosemirror": "3.0.0",
     "@atlaskit/editor-tables": "^2.5.0",