@atlaskit/editor-plugin-collab-edit 7.1.9 → 7.1.11

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 7.1.11
+
+### Patch Changes
+
+- [`60f37549e619c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/60f37549e619c) -
+  Added exclusion list to batchattrs update
+
+## 7.1.10
+
+### Patch Changes
+
+- [`750abc612bfa7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/750abc612bfa7) -
+  Fixed step analytic reporting
+- Updated dependencies
+
 ## 7.1.9
 
 ### Patch Changes

package/dist/cjs/pm-plugins/track-steps.js

@@ -58,6 +58,13 @@ var sanitizeStep = exports.sanitizeStep = function sanitizeStep(step) {
     sanitizedStep.attr = Object.keys(step.attrs).sort().join('_');
   } else if (step instanceof _transform.AddMarkStep || step instanceof _transform.RemoveMarkStep || step instanceof _transform.RemoveNodeMarkStep || step instanceof _transform.AddNodeMarkStep) {
     sanitizedStep.markType = step.mark.type.name;
+  } else if (step instanceof _steps.BatchAttrsStep) {
+    var batched = step.data.map(function (_ref) {
+      var nodeType = _ref.nodeType,
+        attrs = _ref.attrs;
+      return "".concat(nodeType, "_").concat(Object.keys(attrs).sort().join('_'));
+    });
+    sanitizedStep.attr = batched.sort().join('_');
   }
   return sanitizedStep;
 };
@@ -84,10 +91,10 @@ var groupSteps = exports.groupSteps = function groupSteps(sanitizedSteps) {
   var grouped = groupBy(sanitizedSteps, function (e) {
     return Object.values(e).join('_');
   });
-  return Object.entries(grouped).reduce(function (acc, _ref) {
-    var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
-      key = _ref2[0],
-      value = _ref2[1];
+  return Object.entries(grouped).reduce(function (acc, _ref2) {
+    var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
+      key = _ref3[0],
+      value = _ref3[1];
     acc[key] = Array.isArray(value) ? value.length : 0;
     return acc;
   }, {});
@@ -153,11 +160,11 @@ var getScheduler = function getScheduler(obj) {
  * @param {Readonly<Transaction[]>} props.transactions - The transactions that contain the steps.
  * @param {(data: StepMetadataAnalytics[]) => void} props.onTrackDataProcessed - Callback function to be called with the processed data.
  */
-var track = exports.track = function track(_ref3) {
-  var api = _ref3.api,
-    newEditorState = _ref3.newEditorState,
-    transactions = _ref3.transactions,
-    onTrackDataProcessed = _ref3.onTrackDataProcessed;
+var track = exports.track = function track(_ref4) {
+  var api = _ref4.api,
+    newEditorState = _ref4.newEditorState,
+    transactions = _ref4.transactions,
+    onTrackDataProcessed = _ref4.onTrackDataProcessed;
   var newSteps = transactions.flatMap(function (t) {
     return t.steps;
   });

package/dist/cjs/pm-plugins/utils.js

@@ -223,8 +223,8 @@ var isOrganicChange = exports.isOrganicChange = function isOrganicChange(tr) {
         return Object.keys(data.attrs);
       }).flat();
       return _allAttributes.some(function (attr) {
-        return attr !== 'localId';
-      });
+        return !blockedAttrsList.includes(attr);
+      }) && !tr.doc.eq(tr.before);
     }
 
     // If a step is not an instance of SetAttrsStep, it is considered organic
@@ -236,9 +236,7 @@ var isOrganicChange = exports.isOrganicChange = function isOrganicChange(tr) {
     // are not in the `blockedAttributes`. If one of the attributes not on the list, it considers the change
     // organic but only if the entire document is not equal to the previous state.
     return allAttributes.some(function (attr) {
-      if (!blockedAttrsList.includes(attr)) {
-        return true;
-      }
+      return !blockedAttrsList.includes(attr);
     }) && !tr.doc.eq(tr.before);
   });
 };

package/dist/es2019/pm-plugins/track-steps.js

@@ -1,4 +1,4 @@
-import { AnalyticsStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
+import { AnalyticsStep, SetAttrsStep, BatchAttrsStep } from '@atlaskit/adf-schema/steps';
 import { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, RemoveMarkStep, RemoveNodeMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { sendableSteps } from '@atlaskit/prosemirror-collab';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
@@ -47,6 +47,12 @@ export const sanitizeStep = step => {
     sanitizedStep.attr = Object.keys(step.attrs).sort().join('_');
   } else if (step instanceof AddMarkStep || step instanceof RemoveMarkStep || step instanceof RemoveNodeMarkStep || step instanceof AddNodeMarkStep) {
     sanitizedStep.markType = step.mark.type.name;
+  } else if (step instanceof BatchAttrsStep) {
+    const batched = step.data.map(({
+      nodeType,
+      attrs
+    }) => `${nodeType}_${Object.keys(attrs).sort().join('_')}`);
+    sanitizedStep.attr = batched.sort().join('_');
   }
   return sanitizedStep;
 };

package/dist/es2019/pm-plugins/utils.js

@@ -208,7 +208,7 @@ export const isOrganicChange = tr => {
     // editor-plugin-local-id uses BatchAttrStep to set the localId attribute
     if (step instanceof BatchAttrsStep && fg('platform_editor_inorganic_batchattrsstep_localid')) {
       const allAttributes = step.data.map(data => Object.keys(data.attrs)).flat();
-      return allAttributes.some(attr => attr !== 'localId');
+      return allAttributes.some(attr => !blockedAttrsList.includes(attr)) && !tr.doc.eq(tr.before);
     }
 
     // If a step is not an instance of SetAttrsStep, it is considered organic
@@ -219,11 +219,7 @@ export const isOrganicChange = tr => {
     // If a step is an instance of SetAttrsStep, it checks if the attributes in the step
     // are not in the `blockedAttributes`. If one of the attributes not on the list, it considers the change
     // organic but only if the entire document is not equal to the previous state.
-    return allAttributes.some(attr => {
-      if (!blockedAttrsList.includes(attr)) {
-        return true;
-      }
-    }) && !tr.doc.eq(tr.before);
+    return allAttributes.some(attr => !blockedAttrsList.includes(attr)) && !tr.doc.eq(tr.before);
   });
 };
 

package/dist/esm/pm-plugins/track-steps.js

@@ -2,7 +2,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, 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 o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-import { AnalyticsStep, SetAttrsStep } from '@atlaskit/adf-schema/steps';
+import { AnalyticsStep, SetAttrsStep, BatchAttrsStep } from '@atlaskit/adf-schema/steps';
 import { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, RemoveMarkStep, RemoveNodeMarkStep } from '@atlaskit/editor-prosemirror/transform';
 import { sendableSteps } from '@atlaskit/prosemirror-collab';
 import { editorExperiment } from '@atlaskit/tmp-editor-statsig/experiments';
@@ -51,6 +51,13 @@ export var sanitizeStep = function sanitizeStep(step) {
     sanitizedStep.attr = Object.keys(step.attrs).sort().join('_');
   } else if (step instanceof AddMarkStep || step instanceof RemoveMarkStep || step instanceof RemoveNodeMarkStep || step instanceof AddNodeMarkStep) {
     sanitizedStep.markType = step.mark.type.name;
+  } else if (step instanceof BatchAttrsStep) {
+    var batched = step.data.map(function (_ref) {
+      var nodeType = _ref.nodeType,
+        attrs = _ref.attrs;
+      return "".concat(nodeType, "_").concat(Object.keys(attrs).sort().join('_'));
+    });
+    sanitizedStep.attr = batched.sort().join('_');
   }
   return sanitizedStep;
 };
@@ -77,10 +84,10 @@ export var groupSteps = function groupSteps(sanitizedSteps) {
   var grouped = groupBy(sanitizedSteps, function (e) {
     return Object.values(e).join('_');
   });
-  return Object.entries(grouped).reduce(function (acc, _ref) {
-    var _ref2 = _slicedToArray(_ref, 2),
-      key = _ref2[0],
-      value = _ref2[1];
+  return Object.entries(grouped).reduce(function (acc, _ref2) {
+    var _ref3 = _slicedToArray(_ref2, 2),
+      key = _ref3[0],
+      value = _ref3[1];
     acc[key] = Array.isArray(value) ? value.length : 0;
     return acc;
   }, {});
@@ -146,11 +153,11 @@ var getScheduler = function getScheduler(obj) {
  * @param {Readonly<Transaction[]>} props.transactions - The transactions that contain the steps.
  * @param {(data: StepMetadataAnalytics[]) => void} props.onTrackDataProcessed - Callback function to be called with the processed data.
  */
-export var track = function track(_ref3) {
-  var api = _ref3.api,
-    newEditorState = _ref3.newEditorState,
-    transactions = _ref3.transactions,
-    onTrackDataProcessed = _ref3.onTrackDataProcessed;
+export var track = function track(_ref4) {
+  var api = _ref4.api,
+    newEditorState = _ref4.newEditorState,
+    transactions = _ref4.transactions,
+    onTrackDataProcessed = _ref4.onTrackDataProcessed;
   var newSteps = transactions.flatMap(function (t) {
     return t.steps;
   });

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

@@ -215,8 +215,8 @@ export var isOrganicChange = function isOrganicChange(tr) {
         return Object.keys(data.attrs);
       }).flat();
       return _allAttributes.some(function (attr) {
-        return attr !== 'localId';
-      });
+        return !blockedAttrsList.includes(attr);
+      }) && !tr.doc.eq(tr.before);
     }
 
     // If a step is not an instance of SetAttrsStep, it is considered organic
@@ -228,9 +228,7 @@ export var isOrganicChange = function isOrganicChange(tr) {
     // are not in the `blockedAttributes`. If one of the attributes not on the list, it considers the change
     // organic but only if the entire document is not equal to the previous state.
     return allAttributes.some(function (attr) {
-      if (!blockedAttrsList.includes(attr)) {
-        return true;
-      }
+      return !blockedAttrsList.includes(attr);
     }) && !tr.doc.eq(tr.before);
   });
 };

package/dist/types/types/index.d.ts

@@ -1,6 +1,6 @@
 import type { CollabEditOptions, CollabEditProvider, CollabEventConflictPayload, CollabParticipant, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
-import { type Step } from '@atlaskit/editor-prosemirror/dist/types/transform';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import { type Step } from '@atlaskit/editor-prosemirror/transform';
 export type PrivateCollabEditOptions = CollabEditOptions & {
     hideTelecursorOnLoad?: boolean;
     onSyncUpError?: SyncUpErrorFunction;

package/dist/types-ts4.5/types/index.d.ts

@@ -1,6 +1,6 @@
 import type { CollabEditOptions, CollabEditProvider, CollabEventConflictPayload, CollabParticipant, SyncUpErrorFunction } from '@atlaskit/editor-common/collab';
-import { type Step } from '@atlaskit/editor-prosemirror/dist/types/transform';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import { type Step } from '@atlaskit/editor-prosemirror/transform';
 export type PrivateCollabEditOptions = CollabEditOptions & {
     hideTelecursorOnLoad?: boolean;
     onSyncUpError?: SyncUpErrorFunction;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "7.1.9",
+	"version": "7.1.11",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -27,29 +27,29 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^51.5.1",
+		"@atlaskit/adf-schema": "^51.5.0",
 		"@atlaskit/custom-steps": "^0.16.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-plugin-analytics": "^6.2.0",
 		"@atlaskit/editor-plugin-connectivity": "^6.0.0",
 		"@atlaskit/editor-plugin-editor-viewmode": "^8.0.0",
 		"@atlaskit/editor-plugin-feature-flags": "^5.0.0",
-		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@atlaskit/editor-prosemirror": "^7.2.0",
 		"@atlaskit/editor-shared-styles": "^3.10.0",
 		"@atlaskit/frontend-utilities": "^3.2.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.22.0",
-		"@atlaskit/tmp-editor-statsig": "^15.0.0",
+		"@atlaskit/tmp-editor-statsig": "^15.11.0",
 		"@babel/runtime": "^7.0.0",
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.40.0",
+		"@atlaskit/editor-common": "^110.44.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
 	"devDependencies": {
-		"@testing-library/react": "^13.4.0",
+		"@testing-library/react": "^16.3.0",
 		"wait-for-expect": "^1.2.0"
 	},
 	"techstack": {