@atlaskit/editor-plugin-collab-edit 3.8.0 → 3.9.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-plugin-collab-edit
 
+## 3.9.0
+
+### Minor Changes
+
+- [#159232](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/159232)
+  [`3edd7f2ef67fa`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3edd7f2ef67fa) -
+  [EDITOR-752] Add updateSessionMetrics to collab plugin, this will track and store the steps in a
+  single collab session
+
 ## 3.8.0
 
 ### Minor Changes

package/dist/cjs/collabEditPlugin.js

@@ -282,7 +282,9 @@ var collabEditPlugin = exports.collabEditPlugin = function collabEditPlugin(_ref
         hideTelecursorOnLoad: !isEmptyDoc && ((_options$hideTelecurs = options.hideTelecursorOnLoad) !== null && _options$hideTelecurs !== void 0 ? _options$hideTelecurs : false),
         viewMode: viewMode
       }), addErrorAnalytics);
-      (0, _trackSteps.track)(_objectSpread(_objectSpread({}, props), {}, {
+      (0, _trackSteps.track)(_objectSpread(_objectSpread({
+        api: api
+      }, props), {}, {
         onTrackDataProcessed: function onTrackDataProcessed(steps) {
           var _api$analytics3;
           api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 || (_api$analytics3 = _api$analytics3.actions) === null || _api$analytics3 === void 0 || _api$analytics3.fireAnalyticsEvent({

package/dist/cjs/pm-plugins/track-step-metrics.js

@@ -0,0 +1,80 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.updateStepSessionMetrics = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _frontendUtilities = require("@atlaskit/frontend-utilities");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+var STORAGE_CLIENT_KEY = 'ncs-step-metrics-storage';
+var storageClient = new _frontendUtilities.StorageClient(STORAGE_CLIENT_KEY);
+
+/**
+ * Gets the current step session metrics for a given session ID
+ * If the session ID does not exist, it initializes a new metrics object.
+ * It calculates the total size of the steps, the number of steps,
+ * the maximum step size, and the sum of step sizes for P90 calculation.
+ *
+ * @param metrics - The existing metrics object from local storage.
+ * @param sessionId - The session ID for which to get the metrics.
+ * @param steps - The steps to calculate the metrics from.
+ * @returns The updated step session metrics for the given session ID.
+ */
+var getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, steps) {
+  var _metrics$sessionId;
+  var current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
+    totalStepSize: 0,
+    numberOfSteps: 0,
+    maxStepSize: 0,
+    stepSizeSumForP90: []
+  };
+  steps.forEach(function (step) {
+    var stepSize = JSON.stringify(step).length;
+    current.totalStepSize += stepSize;
+    current.numberOfSteps += 1;
+    current.maxStepSize = Math.max(current.maxStepSize, stepSize || 0);
+    current.stepSizeSumForP90.push(stepSize || 0);
+  });
+  return current;
+};
+
+/**
+ * Gets the current active sessions from local storage
+ * If the session ID does not exist, it initializes a new active session.
+ *
+ * This is used in the ncsStepMetricsPlugin to determine if the session is still active
+ * before sending the ncs steps analytics event.
+ *
+ * @param sessionId - The session ID to check or update in local storage.
+ * @returns void
+ */
+var updateActiveSessions = function updateActiveSessions(sessionId) {
+  var currentActiveSessions = JSON.parse(storageClient.getItem('activeSessions') || '{}');
+  if (!currentActiveSessions[sessionId]) {
+    storageClient.setItemWithExpiry('ncsActiveSessions', JSON.stringify(_objectSpread(_objectSpread({}, currentActiveSessions), {}, (0, _defineProperty2.default)({}, sessionId, true))));
+  }
+};
+/**
+ * Updates the step session metrics in local storage for a given session ID.
+ * It calculates the metrics based on the provided steps and updates the storage.
+ *
+ * @param api - The API to access the collab edit plugin.
+ * @param steps - The steps to calculate the metrics from.
+ * @return void
+ */
+var updateStepSessionMetrics = exports.updateStepSessionMetrics = function updateStepSessionMetrics(_ref) {
+  var _api$collabEdit;
+  var api = _ref.api,
+    steps = _ref.steps;
+  var sessionId = api === null || api === void 0 || (_api$collabEdit = api.collabEdit) === null || _api$collabEdit === void 0 || (_api$collabEdit = _api$collabEdit.sharedState.currentState()) === null || _api$collabEdit === void 0 ? void 0 : _api$collabEdit.sessionId;
+  if (!sessionId) {
+    return;
+  }
+  var existingMetrics = JSON.parse(storageClient.getItem('ncsStepSessionMetrics') || '{}');
+  var stepSessionMetrics = getStepSessionMetrics(existingMetrics, sessionId, steps);
+  storageClient.setItemWithExpiry('ncsStepSessionMetrics', JSON.stringify(_objectSpread(_objectSpread({}, existingMetrics), {}, (0, _defineProperty2.default)({}, sessionId, stepSessionMetrics))));
+  updateActiveSessions(sessionId);
+};

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

@@ -8,7 +8,9 @@ exports.track = exports.task = exports.sanitizeStep = exports.groupSteps = void
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _steps = require("@atlaskit/adf-schema/steps");
 var _transform = require("@atlaskit/editor-prosemirror/transform");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _prosemirrorCollab = require("@atlaskit/prosemirror-collab");
+var _trackStepMetrics = require("./track-step-metrics");
 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; }
@@ -146,12 +148,14 @@ var getScheduler = function getScheduler(obj) {
  * This is a non-critical code. If the browser doesn't support the Scheduler API https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/
  *
  * @param {TrackProps} props - The properties required for tracking steps.
+ * @param {ExtractInjectionAPI<CollabEditPlugin> | undefined} props.api - The API for the CollabEdit plugin.
  * @param {EditorState} props.newEditorState - The new editor state.
  * @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 newEditorState = _ref3.newEditorState,
+  var api = _ref3.api,
+    newEditorState = _ref3.newEditorState,
     transactions = _ref3.transactions,
     onTrackDataProcessed = _ref3.onTrackDataProcessed;
   var newSteps = transactions.flatMap(function (t) {
@@ -173,7 +177,13 @@ var track = exports.track = function track(_ref3) {
     steps: steps
   });
   scheduler.postTask(function () {
-    return task(stepsSentCache, onTrackDataProcessed);
+    if ((0, _platformFeatureFlags.fg)('platform_enable_ncs_step_metrics')) {
+      (0, _trackStepMetrics.updateStepSessionMetrics)({
+        api: api,
+        steps: newSteps
+      });
+    }
+    task(stepsSentCache, onTrackDataProcessed);
   }, {
     priority: 'background',
     delay: LOW_PRIORITY_DELAY

package/dist/es2019/collabEditPlugin.js

@@ -231,6 +231,7 @@ export const collabEditPlugin = ({
         viewMode
       }), addErrorAnalytics);
       track({
+        api,
         ...props,
         onTrackDataProcessed: steps => {
           var _api$analytics3, _api$analytics3$actio;

package/dist/es2019/pm-plugins/track-step-metrics.js

@@ -0,0 +1,77 @@
+import { StorageClient } from '@atlaskit/frontend-utilities';
+const STORAGE_CLIENT_KEY = 'ncs-step-metrics-storage';
+const storageClient = new StorageClient(STORAGE_CLIENT_KEY);
+
+/**
+ * Gets the current step session metrics for a given session ID
+ * If the session ID does not exist, it initializes a new metrics object.
+ * It calculates the total size of the steps, the number of steps,
+ * the maximum step size, and the sum of step sizes for P90 calculation.
+ *
+ * @param metrics - The existing metrics object from local storage.
+ * @param sessionId - The session ID for which to get the metrics.
+ * @param steps - The steps to calculate the metrics from.
+ * @returns The updated step session metrics for the given session ID.
+ */
+const getStepSessionMetrics = (metrics, sessionId, steps) => {
+  var _metrics$sessionId;
+  const current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
+    totalStepSize: 0,
+    numberOfSteps: 0,
+    maxStepSize: 0,
+    stepSizeSumForP90: []
+  };
+  steps.forEach(step => {
+    const stepSize = JSON.stringify(step).length;
+    current.totalStepSize += stepSize;
+    current.numberOfSteps += 1;
+    current.maxStepSize = Math.max(current.maxStepSize, stepSize || 0);
+    current.stepSizeSumForP90.push(stepSize || 0);
+  });
+  return current;
+};
+
+/**
+ * Gets the current active sessions from local storage
+ * If the session ID does not exist, it initializes a new active session.
+ *
+ * This is used in the ncsStepMetricsPlugin to determine if the session is still active
+ * before sending the ncs steps analytics event.
+ *
+ * @param sessionId - The session ID to check or update in local storage.
+ * @returns void
+ */
+const updateActiveSessions = sessionId => {
+  const currentActiveSessions = JSON.parse(storageClient.getItem('activeSessions') || '{}');
+  if (!currentActiveSessions[sessionId]) {
+    storageClient.setItemWithExpiry('ncsActiveSessions', JSON.stringify({
+      ...currentActiveSessions,
+      [sessionId]: true
+    }));
+  }
+};
+/**
+ * Updates the step session metrics in local storage for a given session ID.
+ * It calculates the metrics based on the provided steps and updates the storage.
+ *
+ * @param api - The API to access the collab edit plugin.
+ * @param steps - The steps to calculate the metrics from.
+ * @return void
+ */
+export const updateStepSessionMetrics = ({
+  api,
+  steps
+}) => {
+  var _api$collabEdit, _api$collabEdit$share;
+  const sessionId = api === null || api === void 0 ? void 0 : (_api$collabEdit = api.collabEdit) === null || _api$collabEdit === void 0 ? void 0 : (_api$collabEdit$share = _api$collabEdit.sharedState.currentState()) === null || _api$collabEdit$share === void 0 ? void 0 : _api$collabEdit$share.sessionId;
+  if (!sessionId) {
+    return;
+  }
+  const existingMetrics = JSON.parse(storageClient.getItem('ncsStepSessionMetrics') || '{}');
+  const stepSessionMetrics = getStepSessionMetrics(existingMetrics, sessionId, steps);
+  storageClient.setItemWithExpiry('ncsStepSessionMetrics', JSON.stringify({
+    ...existingMetrics,
+    [sessionId]: stepSessionMetrics
+  }));
+  updateActiveSessions(sessionId);
+};

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

@@ -1,6 +1,8 @@
 import { SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, RemoveMarkStep, RemoveNodeMarkStep } from '@atlaskit/editor-prosemirror/transform';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { sendableSteps } from '@atlaskit/prosemirror-collab';
+import { updateStepSessionMetrics } from './track-step-metrics';
 function groupBy(array, keyGetter) {
   // Check group by exists, and that it's a function. If so, use the native browser code
   if ('groupBy' in Object && typeof Object.groupBy === 'function') {
@@ -123,11 +125,13 @@ const getScheduler = obj => {
  * This is a non-critical code. If the browser doesn't support the Scheduler API https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/
  *
  * @param {TrackProps} props - The properties required for tracking steps.
+ * @param {ExtractInjectionAPI<CollabEditPlugin> | undefined} props.api - The API for the CollabEdit plugin.
  * @param {EditorState} props.newEditorState - The new editor state.
  * @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 const track = ({
+  api,
   newEditorState,
   transactions,
   onTrackDataProcessed
@@ -150,7 +154,15 @@ export const track = ({
     endedAt,
     steps
   });
-  scheduler.postTask(() => task(stepsSentCache, onTrackDataProcessed), {
+  scheduler.postTask(() => {
+    if (fg('platform_enable_ncs_step_metrics')) {
+      updateStepSessionMetrics({
+        api,
+        steps: newSteps
+      });
+    }
+    task(stepsSentCache, onTrackDataProcessed);
+  }, {
     priority: 'background',
     delay: LOW_PRIORITY_DELAY
   });

package/dist/esm/collabEditPlugin.js

@@ -275,7 +275,9 @@ export var collabEditPlugin = function collabEditPlugin(_ref4) {
         hideTelecursorOnLoad: !isEmptyDoc && ((_options$hideTelecurs = options.hideTelecursorOnLoad) !== null && _options$hideTelecurs !== void 0 ? _options$hideTelecurs : false),
         viewMode: viewMode
       }), addErrorAnalytics);
-      track(_objectSpread(_objectSpread({}, props), {}, {
+      track(_objectSpread(_objectSpread({
+        api: api
+      }, props), {}, {
         onTrackDataProcessed: function onTrackDataProcessed(steps) {
           var _api$analytics3;
           api === null || api === void 0 || (_api$analytics3 = api.analytics) === null || _api$analytics3 === void 0 || (_api$analytics3 = _api$analytics3.actions) === null || _api$analytics3 === void 0 || _api$analytics3.fireAnalyticsEvent({

package/dist/esm/pm-plugins/track-step-metrics.js

@@ -0,0 +1,73 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { StorageClient } from '@atlaskit/frontend-utilities';
+var STORAGE_CLIENT_KEY = 'ncs-step-metrics-storage';
+var storageClient = new StorageClient(STORAGE_CLIENT_KEY);
+
+/**
+ * Gets the current step session metrics for a given session ID
+ * If the session ID does not exist, it initializes a new metrics object.
+ * It calculates the total size of the steps, the number of steps,
+ * the maximum step size, and the sum of step sizes for P90 calculation.
+ *
+ * @param metrics - The existing metrics object from local storage.
+ * @param sessionId - The session ID for which to get the metrics.
+ * @param steps - The steps to calculate the metrics from.
+ * @returns The updated step session metrics for the given session ID.
+ */
+var getStepSessionMetrics = function getStepSessionMetrics(metrics, sessionId, steps) {
+  var _metrics$sessionId;
+  var current = (_metrics$sessionId = metrics[sessionId]) !== null && _metrics$sessionId !== void 0 ? _metrics$sessionId : {
+    totalStepSize: 0,
+    numberOfSteps: 0,
+    maxStepSize: 0,
+    stepSizeSumForP90: []
+  };
+  steps.forEach(function (step) {
+    var stepSize = JSON.stringify(step).length;
+    current.totalStepSize += stepSize;
+    current.numberOfSteps += 1;
+    current.maxStepSize = Math.max(current.maxStepSize, stepSize || 0);
+    current.stepSizeSumForP90.push(stepSize || 0);
+  });
+  return current;
+};
+
+/**
+ * Gets the current active sessions from local storage
+ * If the session ID does not exist, it initializes a new active session.
+ *
+ * This is used in the ncsStepMetricsPlugin to determine if the session is still active
+ * before sending the ncs steps analytics event.
+ *
+ * @param sessionId - The session ID to check or update in local storage.
+ * @returns void
+ */
+var updateActiveSessions = function updateActiveSessions(sessionId) {
+  var currentActiveSessions = JSON.parse(storageClient.getItem('activeSessions') || '{}');
+  if (!currentActiveSessions[sessionId]) {
+    storageClient.setItemWithExpiry('ncsActiveSessions', JSON.stringify(_objectSpread(_objectSpread({}, currentActiveSessions), {}, _defineProperty({}, sessionId, true))));
+  }
+};
+/**
+ * Updates the step session metrics in local storage for a given session ID.
+ * It calculates the metrics based on the provided steps and updates the storage.
+ *
+ * @param api - The API to access the collab edit plugin.
+ * @param steps - The steps to calculate the metrics from.
+ * @return void
+ */
+export var updateStepSessionMetrics = function updateStepSessionMetrics(_ref) {
+  var _api$collabEdit;
+  var api = _ref.api,
+    steps = _ref.steps;
+  var sessionId = api === null || api === void 0 || (_api$collabEdit = api.collabEdit) === null || _api$collabEdit === void 0 || (_api$collabEdit = _api$collabEdit.sharedState.currentState()) === null || _api$collabEdit === void 0 ? void 0 : _api$collabEdit.sessionId;
+  if (!sessionId) {
+    return;
+  }
+  var existingMetrics = JSON.parse(storageClient.getItem('ncsStepSessionMetrics') || '{}');
+  var stepSessionMetrics = getStepSessionMetrics(existingMetrics, sessionId, steps);
+  storageClient.setItemWithExpiry('ncsStepSessionMetrics', JSON.stringify(_objectSpread(_objectSpread({}, existingMetrics), {}, _defineProperty({}, sessionId, stepSessionMetrics))));
+  updateActiveSessions(sessionId);
+};

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

@@ -4,7 +4,9 @@ function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r)
 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 { SetAttrsStep } from '@atlaskit/adf-schema/steps';
 import { AddMarkStep, AddNodeMarkStep, AttrStep, DocAttrStep, RemoveMarkStep, RemoveNodeMarkStep } from '@atlaskit/editor-prosemirror/transform';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { sendableSteps } from '@atlaskit/prosemirror-collab';
+import { updateStepSessionMetrics } from './track-step-metrics';
 function groupBy(array, keyGetter) {
   // Check group by exists, and that it's a function. If so, use the native browser code
   if ('groupBy' in Object && typeof Object.groupBy === 'function') {
@@ -139,12 +141,14 @@ var getScheduler = function getScheduler(obj) {
  * This is a non-critical code. If the browser doesn't support the Scheduler API https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/
  *
  * @param {TrackProps} props - The properties required for tracking steps.
+ * @param {ExtractInjectionAPI<CollabEditPlugin> | undefined} props.api - The API for the CollabEdit plugin.
  * @param {EditorState} props.newEditorState - The new editor state.
  * @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 newEditorState = _ref3.newEditorState,
+  var api = _ref3.api,
+    newEditorState = _ref3.newEditorState,
     transactions = _ref3.transactions,
     onTrackDataProcessed = _ref3.onTrackDataProcessed;
   var newSteps = transactions.flatMap(function (t) {
@@ -166,7 +170,13 @@ export var track = function track(_ref3) {
     steps: steps
   });
   scheduler.postTask(function () {
-    return task(stepsSentCache, onTrackDataProcessed);
+    if (fg('platform_enable_ncs_step_metrics')) {
+      updateStepSessionMetrics({
+        api: api,
+        steps: newSteps
+      });
+    }
+    task(stepsSentCache, onTrackDataProcessed);
   }, {
     priority: 'background',
     delay: LOW_PRIORITY_DELAY

package/dist/types/pm-plugins/track-step-metrics.d.ts

@@ -0,0 +1,17 @@
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { Step } from '@atlaskit/editor-prosemirror/transform';
+import { CollabEditPlugin } from '../collabEditPluginType';
+type UpdateStepSessionMetricProps = {
+    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
+    steps: Step[];
+};
+/**
+ * Updates the step session metrics in local storage for a given session ID.
+ * It calculates the metrics based on the provided steps and updates the storage.
+ *
+ * @param api - The API to access the collab edit plugin.
+ * @param steps - The steps to calculate the metrics from.
+ * @return void
+ */
+export declare const updateStepSessionMetrics: ({ api, steps }: UpdateStepSessionMetricProps) => void;
+export {};

package/dist/types/pm-plugins/track-steps.d.ts

@@ -1,5 +1,7 @@
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import { CollabEditPlugin } from '../collabEditPluginType';
 export type SanitizedStep = {
     stepType: string;
     attr?: string;
@@ -59,6 +61,7 @@ export type CacheType = Map<number, {
     endedAt: number;
 }>;
 type TrackProps = {
+    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
     newEditorState: EditorState;
     transactions: Readonly<Transaction[]>;
     onTrackDataProcessed: (data: StepMetadataAnalytics[]) => void;
@@ -69,9 +72,10 @@ type TrackProps = {
  * This is a non-critical code. If the browser doesn't support the Scheduler API https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/
  *
  * @param {TrackProps} props - The properties required for tracking steps.
+ * @param {ExtractInjectionAPI<CollabEditPlugin> | undefined} props.api - The API for the CollabEdit plugin.
  * @param {EditorState} props.newEditorState - The new editor state.
  * @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 declare const track: ({ newEditorState, transactions, onTrackDataProcessed }: TrackProps) => void;
+export declare const track: ({ api, newEditorState, transactions, onTrackDataProcessed }: TrackProps) => void;
 export {};

package/dist/types-ts4.5/pm-plugins/track-step-metrics.d.ts

@@ -0,0 +1,17 @@
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { Step } from '@atlaskit/editor-prosemirror/transform';
+import { CollabEditPlugin } from '../collabEditPluginType';
+type UpdateStepSessionMetricProps = {
+    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
+    steps: Step[];
+};
+/**
+ * Updates the step session metrics in local storage for a given session ID.
+ * It calculates the metrics based on the provided steps and updates the storage.
+ *
+ * @param api - The API to access the collab edit plugin.
+ * @param steps - The steps to calculate the metrics from.
+ * @return void
+ */
+export declare const updateStepSessionMetrics: ({ api, steps }: UpdateStepSessionMetricProps) => void;
+export {};

package/dist/types-ts4.5/pm-plugins/track-steps.d.ts

@@ -1,5 +1,7 @@
+import { ExtractInjectionAPI } from '@atlaskit/editor-common/types';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { Step } from '@atlaskit/editor-prosemirror/transform';
+import { CollabEditPlugin } from '../collabEditPluginType';
 export type SanitizedStep = {
     stepType: string;
     attr?: string;
@@ -59,6 +61,7 @@ export type CacheType = Map<number, {
     endedAt: number;
 }>;
 type TrackProps = {
+    api: ExtractInjectionAPI<CollabEditPlugin> | undefined;
     newEditorState: EditorState;
     transactions: Readonly<Transaction[]>;
     onTrackDataProcessed: (data: StepMetadataAnalytics[]) => void;
@@ -69,9 +72,10 @@ type TrackProps = {
  * This is a non-critical code. If the browser doesn't support the Scheduler API https://developer.mozilla.org/en-US/docs/Web/API/Scheduler/
  *
  * @param {TrackProps} props - The properties required for tracking steps.
+ * @param {ExtractInjectionAPI<CollabEditPlugin> | undefined} props.api - The API for the CollabEdit plugin.
  * @param {EditorState} props.newEditorState - The new editor state.
  * @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 declare const track: ({ newEditorState, transactions, onTrackDataProcessed }: TrackProps) => void;
+export declare const track: ({ api, newEditorState, transactions, onTrackDataProcessed }: TrackProps) => void;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-collab-edit",
-	"version": "3.8.0",
+	"version": "3.9.0",
 	"description": "Collab Edit plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^47.6.0",
 		"@atlaskit/custom-steps": "^0.11.0",
-		"@atlaskit/editor-common": "^106.0.0",
+		"@atlaskit/editor-common": "^106.1.0",
 		"@atlaskit/editor-json-transformer": "^8.24.0",
 		"@atlaskit/editor-plugin-analytics": "^2.3.0",
 		"@atlaskit/editor-plugin-connectivity": "^2.0.0",
@@ -41,6 +41,7 @@
 		"@atlaskit/editor-plugin-feature-flags": "^1.4.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.4.0",
+		"@atlaskit/frontend-utilities": "^3.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/prosemirror-collab": "^0.17.0",
 		"@atlaskit/tmp-editor-statsig": "^5.5.0",
@@ -115,6 +116,9 @@
 		},
 		"confluence_team_presence_scroll_to_pointer": {
 			"type": "boolean"
+		},
+		"platform_enable_ncs_step_metrics": {
+			"type": "boolean"
 		}
 	}
 }