@atlaskit/editor-plugin-metrics 1.1.0

package/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+	rules: {
+	  '@typescript-eslint/no-duplicate-imports': 'error',
+	  '@typescript-eslint/no-explicit-any': 'error',
+	},
+	overrides: [
+	  {
+		files: ['**/__tests__/**/*.{js,ts,tsx}', '**/examples/**/*.{js,ts,tsx}'],
+		rules: {
+		  '@typescript-eslint/no-explicit-any': 'off',
+		},
+	  },
+	],
+  };

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @atlaskit/editor-plugin-metrics
+
+## 1.1.0
+
+### Minor Changes
+
+- [#100173](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/100173)
+  [`ab687f83ea47e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/ab687f83ea47e) -
+  ED-26142 Set up metrics plugin for measuring efficiency and effectiveness in editor
+
+## 1.0.0

package/LICENSE.md

@@ -0,0 +1,11 @@
+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,10 @@
+# EditorPluginMetrics
+
+Metrics plugin for @atlaskit/editor-core
+
+## Usage
+
+`import EditorPluginMetrics from '@atlaskit/editor-plugin-metrics';`
+
+Detailed docs and example usage can be found
+[here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-metrics).

package/dist/cjs/index.js

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

package/dist/cjs/metricsPlugin.js

@@ -0,0 +1,78 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.metricsPlugin = void 0;
+var _main = require("./pm-plugins/main");
+/**
+ * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+var metricsPlugin = exports.metricsPlugin = function metricsPlugin(_ref) {
+  var api = _ref.api;
+  return {
+    name: 'metrics',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'metrics',
+        plugin: function plugin() {
+          return (0, _main.createPlugin)(api);
+        }
+      }];
+    },
+    commands: {
+      stopActiveSession: function stopActiveSession() {
+        return function (_ref2) {
+          var tr = _ref2.tr;
+          if (!api) {
+            return tr;
+          }
+          var newTr = tr;
+          newTr.setMeta(_main.metricsKey, {
+            stopActiveSession: true
+          });
+          return newTr;
+        };
+      },
+      fireSessionAnalytics: function fireSessionAnalytics() {
+        return function (_ref3) {
+          var tr = _ref3.tr;
+          if (!api) {
+            return tr;
+          }
+          var state = api.metrics.sharedState.currentState();
+          if (!state) {
+            return tr;
+          }
+
+          // const eventAttributes = {
+          // 	efficiency: {
+          // 		totalActiveTime: state.activeSessionTime || 0,
+          // 		totalActionCount: state.totalActionCount || 0,
+          // 		actionTypeCount: state.actionTypeCount,
+          // 		totalInactiveTime:
+          // 			Date.now() - (state.editSessionStartTime || 0) - (state.activeSessionTime || 0),
+          // 	},
+          // TODO: Add effectiveness attributes
+          // effectiveness: {
+          // 	undoCount: 0,
+          // 	repeatedActionCount: 0,
+          // 	safeInsertCount: 0,
+          // },
+          // };
+
+          // fire analytics event
+          // api.analytics.actions.attachAnalyticsEvent({});
+          return tr;
+        };
+      }
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return _main.initialPluginState;
+      }
+      return _main.metricsKey.getState(editorState);
+    }
+  };
+};

package/dist/cjs/metricsPluginType.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

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

@@ -0,0 +1,119 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.metricsKey = exports.initialPluginState = exports.createPlugin = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _steps = require("@atlaskit/adf-schema/steps");
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _utils = require("@atlaskit/editor-common/utils");
+var _state = require("@atlaskit/editor-prosemirror/state");
+var _activeSessionTimer = require("./utils/active-session-timer");
+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 metricsKey = exports.metricsKey = new _state.PluginKey('metricsPlugin');
+var initialPluginState = exports.initialPluginState = {
+  editSessionStartTime: undefined,
+  intentToStartEditTime: undefined,
+  lastSelection: undefined,
+  activeSessionTime: 0,
+  totalActionCount: 0,
+  timeOfLastTextInput: undefined,
+  actionTypeCount: {
+    textInputCount: 0,
+    nodeInsertionCount: 0,
+    nodeAttributeChangeCount: 0,
+    contentMovedCount: 0,
+    nodeDeletionCount: 0
+  }
+};
+var createPlugin = exports.createPlugin = function createPlugin(api) {
+  var timer = new _activeSessionTimer.ActiveSessionTimer(api);
+  return new _safePlugin.SafePlugin({
+    key: metricsKey,
+    state: {
+      init: function init() {
+        return _objectSpread(_objectSpread({}, initialPluginState), {}, {
+          editSessionStartTime: performance.now()
+        });
+      },
+      apply: function apply(tr, pluginState) {
+        var meta = tr.getMeta(metricsKey);
+        var intentToStartEditTime = (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime;
+        if (meta && meta.stopActiveSession) {
+          // console.log('stopActiveSession');
+          return _objectSpread(_objectSpread({}, pluginState), {}, {
+            intentToStartEditTime: undefined,
+            lastSelection: undefined
+          });
+        }
+        if (!intentToStartEditTime) {
+          return pluginState;
+        }
+        var canIgnoreTr = function canIgnoreTr() {
+          return !tr.steps.every(function (e) {
+            return e instanceof _steps.AnalyticsStep;
+          });
+        };
+        if (tr.docChanged && canIgnoreTr()) {
+          var now = performance.now();
+          timer.startTimer();
+
+          // If previous and current action is text insertion, then don't increase total action count
+          var isActionTextInput = (0, _utils.isTextInput)(tr);
+          if (pluginState.timeOfLastTextInput && isActionTextInput) {
+            return _objectSpread(_objectSpread({}, pluginState), {}, {
+              activeSessionTime: pluginState.activeSessionTime + (now - pluginState.timeOfLastTextInput),
+              totalActionCount: pluginState.totalActionCount,
+              timeOfLastTextInput: now
+            });
+          }
+
+          // TODO: Add actionTypeCount
+          return _objectSpread(_objectSpread({}, pluginState), {}, {
+            activeSessionTime: pluginState.activeSessionTime + (now - intentToStartEditTime),
+            totalActionCount: pluginState.totalActionCount + 1,
+            timeOfLastTextInput: isActionTextInput ? now : undefined
+          });
+        }
+        return _objectSpread(_objectSpread({}, pluginState), {}, {
+          lastSelection: (meta === null || meta === void 0 ? void 0 : meta.newSelection) || pluginState.lastSelection,
+          intentToStartEditTime: (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime
+        });
+      }
+    },
+    view: function view() {
+      return {
+        destroy: function destroy() {
+          var _api$metrics;
+          api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.fireSessionAnalytics());
+          timer.cleanupTimer();
+        }
+      };
+    },
+    props: {
+      handleDOMEvents: {
+        click: function click(view) {
+          var _pluginState$lastSele, _pluginState$lastSele2;
+          var pluginState = api === null || api === void 0 ? void 0 : api.metrics.sharedState.currentState();
+          if (!pluginState || pluginState.intentToStartEditTime) {
+            return false;
+          }
+          var newSelection = view.state.tr.selection;
+          var newTr = view.state.tr;
+          if ((pluginState === null || pluginState === void 0 || (_pluginState$lastSele = pluginState.lastSelection) === null || _pluginState$lastSele === void 0 ? void 0 : _pluginState$lastSele.from) !== newSelection.from && (pluginState === null || pluginState === void 0 || (_pluginState$lastSele2 = pluginState.lastSelection) === null || _pluginState$lastSele2 === void 0 ? void 0 : _pluginState$lastSele2.to) !== newSelection.to) {
+            newTr.setMeta(metricsKey, {
+              intentToStartEditTime: performance.now(),
+              newSelection: newSelection
+            });
+            view.dispatch(newTr);
+            timer.startTimer();
+          }
+          return false;
+        }
+      }
+    }
+  });
+};

package/dist/cjs/pm-plugins/utils/active-session-timer.js

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ActiveSessionTimer = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var ActiveSessionTimer = exports.ActiveSessionTimer = /*#__PURE__*/(0, _createClass2.default)(function ActiveSessionTimer(api) {
+  var _this = this;
+  (0, _classCallCheck2.default)(this, ActiveSessionTimer);
+  (0, _defineProperty2.default)(this, "startTimer", function () {
+    if (_this.timerId) {
+      clearTimeout(_this.timerId);
+    }
+    _this.timerId = window.setTimeout(function () {
+      _this.cleanupTimer();
+    }, 3000);
+  });
+  (0, _defineProperty2.default)(this, "cleanupTimer", function () {
+    if (_this.api) {
+      var _this$api$metrics;
+      _this.api.core.actions.execute((_this$api$metrics = _this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
+    }
+    if (_this.timerId) {
+      clearTimeout(_this.timerId);
+      _this.timerId = null;
+    }
+  });
+  this.timerId = null;
+  this.api = api;
+});

package/dist/es2019/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { metricsPlugin } from './metricsPlugin';

package/dist/es2019/metricsPlugin.js

@@ -0,0 +1,67 @@
+import { createPlugin, initialPluginState, metricsKey } from './pm-plugins/main';
+/**
+ * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export const metricsPlugin = ({
+  api
+}) => ({
+  name: 'metrics',
+  pmPlugins() {
+    return [{
+      name: 'metrics',
+      plugin: () => createPlugin(api)
+    }];
+  },
+  commands: {
+    stopActiveSession: () => ({
+      tr
+    }) => {
+      if (!api) {
+        return tr;
+      }
+      const newTr = tr;
+      newTr.setMeta(metricsKey, {
+        stopActiveSession: true
+      });
+      return newTr;
+    },
+    fireSessionAnalytics: () => ({
+      tr
+    }) => {
+      if (!api) {
+        return tr;
+      }
+      const state = api.metrics.sharedState.currentState();
+      if (!state) {
+        return tr;
+      }
+
+      // const eventAttributes = {
+      // 	efficiency: {
+      // 		totalActiveTime: state.activeSessionTime || 0,
+      // 		totalActionCount: state.totalActionCount || 0,
+      // 		actionTypeCount: state.actionTypeCount,
+      // 		totalInactiveTime:
+      // 			Date.now() - (state.editSessionStartTime || 0) - (state.activeSessionTime || 0),
+      // 	},
+      // TODO: Add effectiveness attributes
+      // effectiveness: {
+      // 	undoCount: 0,
+      // 	repeatedActionCount: 0,
+      // 	safeInsertCount: 0,
+      // },
+      // };
+
+      // fire analytics event
+      // api.analytics.actions.attachAnalyticsEvent({});
+      return tr;
+    }
+  },
+  getSharedState(editorState) {
+    if (!editorState) {
+      return initialPluginState;
+    }
+    return metricsKey.getState(editorState);
+  }
+});

package/dist/es2019/metricsPluginType.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,110 @@
+import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { isTextInput } from '@atlaskit/editor-common/utils';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { ActiveSessionTimer } from './utils/active-session-timer';
+export const metricsKey = new PluginKey('metricsPlugin');
+export const initialPluginState = {
+  editSessionStartTime: undefined,
+  intentToStartEditTime: undefined,
+  lastSelection: undefined,
+  activeSessionTime: 0,
+  totalActionCount: 0,
+  timeOfLastTextInput: undefined,
+  actionTypeCount: {
+    textInputCount: 0,
+    nodeInsertionCount: 0,
+    nodeAttributeChangeCount: 0,
+    contentMovedCount: 0,
+    nodeDeletionCount: 0
+  }
+};
+export const createPlugin = api => {
+  const timer = new ActiveSessionTimer(api);
+  return new SafePlugin({
+    key: metricsKey,
+    state: {
+      init: () => {
+        return {
+          ...initialPluginState,
+          editSessionStartTime: performance.now()
+        };
+      },
+      apply(tr, pluginState) {
+        const meta = tr.getMeta(metricsKey);
+        const intentToStartEditTime = (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime;
+        if (meta && meta.stopActiveSession) {
+          // console.log('stopActiveSession');
+          return {
+            ...pluginState,
+            intentToStartEditTime: undefined,
+            lastSelection: undefined
+          };
+        }
+        if (!intentToStartEditTime) {
+          return pluginState;
+        }
+        const canIgnoreTr = () => !tr.steps.every(e => e instanceof AnalyticsStep);
+        if (tr.docChanged && canIgnoreTr()) {
+          const now = performance.now();
+          timer.startTimer();
+
+          // If previous and current action is text insertion, then don't increase total action count
+          const isActionTextInput = isTextInput(tr);
+          if (pluginState.timeOfLastTextInput && isActionTextInput) {
+            return {
+              ...pluginState,
+              activeSessionTime: pluginState.activeSessionTime + (now - pluginState.timeOfLastTextInput),
+              totalActionCount: pluginState.totalActionCount,
+              timeOfLastTextInput: now
+            };
+          }
+
+          // TODO: Add actionTypeCount
+          return {
+            ...pluginState,
+            activeSessionTime: pluginState.activeSessionTime + (now - intentToStartEditTime),
+            totalActionCount: pluginState.totalActionCount + 1,
+            timeOfLastTextInput: isActionTextInput ? now : undefined
+          };
+        }
+        return {
+          ...pluginState,
+          lastSelection: (meta === null || meta === void 0 ? void 0 : meta.newSelection) || pluginState.lastSelection,
+          intentToStartEditTime: (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime
+        };
+      }
+    },
+    view() {
+      return {
+        destroy() {
+          var _api$metrics;
+          api === null || api === void 0 ? void 0 : api.core.actions.execute(api === null || api === void 0 ? void 0 : (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.fireSessionAnalytics());
+          timer.cleanupTimer();
+        }
+      };
+    },
+    props: {
+      handleDOMEvents: {
+        click: view => {
+          var _pluginState$lastSele, _pluginState$lastSele2;
+          const pluginState = api === null || api === void 0 ? void 0 : api.metrics.sharedState.currentState();
+          if (!pluginState || pluginState.intentToStartEditTime) {
+            return false;
+          }
+          const newSelection = view.state.tr.selection;
+          const newTr = view.state.tr;
+          if ((pluginState === null || pluginState === void 0 ? void 0 : (_pluginState$lastSele = pluginState.lastSelection) === null || _pluginState$lastSele === void 0 ? void 0 : _pluginState$lastSele.from) !== newSelection.from && (pluginState === null || pluginState === void 0 ? void 0 : (_pluginState$lastSele2 = pluginState.lastSelection) === null || _pluginState$lastSele2 === void 0 ? void 0 : _pluginState$lastSele2.to) !== newSelection.to) {
+            newTr.setMeta(metricsKey, {
+              intentToStartEditTime: performance.now(),
+              newSelection: newSelection
+            });
+            view.dispatch(newTr);
+            timer.startTimer();
+          }
+          return false;
+        }
+      }
+    }
+  });
+};

package/dist/es2019/pm-plugins/utils/active-session-timer.js

@@ -0,0 +1,25 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+export class ActiveSessionTimer {
+  constructor(api) {
+    _defineProperty(this, "startTimer", () => {
+      if (this.timerId) {
+        clearTimeout(this.timerId);
+      }
+      this.timerId = window.setTimeout(() => {
+        this.cleanupTimer();
+      }, 3000);
+    });
+    _defineProperty(this, "cleanupTimer", () => {
+      if (this.api) {
+        var _this$api$metrics;
+        this.api.core.actions.execute((_this$api$metrics = this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
+      }
+      if (this.timerId) {
+        clearTimeout(this.timerId);
+        this.timerId = null;
+      }
+    });
+    this.timerId = null;
+    this.api = api;
+  }
+}

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+/* eslint-disable @atlaskit/editor/no-re-export */
+// Entry file in package.json
+
+export { metricsPlugin } from './metricsPlugin';

package/dist/esm/metricsPlugin.js

@@ -0,0 +1,72 @@
+import { createPlugin, initialPluginState, metricsKey } from './pm-plugins/main';
+/**
+ * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export var metricsPlugin = function metricsPlugin(_ref) {
+  var api = _ref.api;
+  return {
+    name: 'metrics',
+    pmPlugins: function pmPlugins() {
+      return [{
+        name: 'metrics',
+        plugin: function plugin() {
+          return createPlugin(api);
+        }
+      }];
+    },
+    commands: {
+      stopActiveSession: function stopActiveSession() {
+        return function (_ref2) {
+          var tr = _ref2.tr;
+          if (!api) {
+            return tr;
+          }
+          var newTr = tr;
+          newTr.setMeta(metricsKey, {
+            stopActiveSession: true
+          });
+          return newTr;
+        };
+      },
+      fireSessionAnalytics: function fireSessionAnalytics() {
+        return function (_ref3) {
+          var tr = _ref3.tr;
+          if (!api) {
+            return tr;
+          }
+          var state = api.metrics.sharedState.currentState();
+          if (!state) {
+            return tr;
+          }
+
+          // const eventAttributes = {
+          // 	efficiency: {
+          // 		totalActiveTime: state.activeSessionTime || 0,
+          // 		totalActionCount: state.totalActionCount || 0,
+          // 		actionTypeCount: state.actionTypeCount,
+          // 		totalInactiveTime:
+          // 			Date.now() - (state.editSessionStartTime || 0) - (state.activeSessionTime || 0),
+          // 	},
+          // TODO: Add effectiveness attributes
+          // effectiveness: {
+          // 	undoCount: 0,
+          // 	repeatedActionCount: 0,
+          // 	safeInsertCount: 0,
+          // },
+          // };
+
+          // fire analytics event
+          // api.analytics.actions.attachAnalyticsEvent({});
+          return tr;
+        };
+      }
+    },
+    getSharedState: function getSharedState(editorState) {
+      if (!editorState) {
+        return initialPluginState;
+      }
+      return metricsKey.getState(editorState);
+    }
+  };
+};

package/dist/esm/metricsPluginType.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,112 @@
+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 { AnalyticsStep } from '@atlaskit/adf-schema/steps';
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { isTextInput } from '@atlaskit/editor-common/utils';
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import { ActiveSessionTimer } from './utils/active-session-timer';
+export var metricsKey = new PluginKey('metricsPlugin');
+export var initialPluginState = {
+  editSessionStartTime: undefined,
+  intentToStartEditTime: undefined,
+  lastSelection: undefined,
+  activeSessionTime: 0,
+  totalActionCount: 0,
+  timeOfLastTextInput: undefined,
+  actionTypeCount: {
+    textInputCount: 0,
+    nodeInsertionCount: 0,
+    nodeAttributeChangeCount: 0,
+    contentMovedCount: 0,
+    nodeDeletionCount: 0
+  }
+};
+export var createPlugin = function createPlugin(api) {
+  var timer = new ActiveSessionTimer(api);
+  return new SafePlugin({
+    key: metricsKey,
+    state: {
+      init: function init() {
+        return _objectSpread(_objectSpread({}, initialPluginState), {}, {
+          editSessionStartTime: performance.now()
+        });
+      },
+      apply: function apply(tr, pluginState) {
+        var meta = tr.getMeta(metricsKey);
+        var intentToStartEditTime = (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime;
+        if (meta && meta.stopActiveSession) {
+          // console.log('stopActiveSession');
+          return _objectSpread(_objectSpread({}, pluginState), {}, {
+            intentToStartEditTime: undefined,
+            lastSelection: undefined
+          });
+        }
+        if (!intentToStartEditTime) {
+          return pluginState;
+        }
+        var canIgnoreTr = function canIgnoreTr() {
+          return !tr.steps.every(function (e) {
+            return e instanceof AnalyticsStep;
+          });
+        };
+        if (tr.docChanged && canIgnoreTr()) {
+          var now = performance.now();
+          timer.startTimer();
+
+          // If previous and current action is text insertion, then don't increase total action count
+          var isActionTextInput = isTextInput(tr);
+          if (pluginState.timeOfLastTextInput && isActionTextInput) {
+            return _objectSpread(_objectSpread({}, pluginState), {}, {
+              activeSessionTime: pluginState.activeSessionTime + (now - pluginState.timeOfLastTextInput),
+              totalActionCount: pluginState.totalActionCount,
+              timeOfLastTextInput: now
+            });
+          }
+
+          // TODO: Add actionTypeCount
+          return _objectSpread(_objectSpread({}, pluginState), {}, {
+            activeSessionTime: pluginState.activeSessionTime + (now - intentToStartEditTime),
+            totalActionCount: pluginState.totalActionCount + 1,
+            timeOfLastTextInput: isActionTextInput ? now : undefined
+          });
+        }
+        return _objectSpread(_objectSpread({}, pluginState), {}, {
+          lastSelection: (meta === null || meta === void 0 ? void 0 : meta.newSelection) || pluginState.lastSelection,
+          intentToStartEditTime: (meta === null || meta === void 0 ? void 0 : meta.intentToStartEditTime) || pluginState.intentToStartEditTime
+        });
+      }
+    },
+    view: function view() {
+      return {
+        destroy: function destroy() {
+          var _api$metrics;
+          api === null || api === void 0 || api.core.actions.execute(api === null || api === void 0 || (_api$metrics = api.metrics) === null || _api$metrics === void 0 ? void 0 : _api$metrics.commands.fireSessionAnalytics());
+          timer.cleanupTimer();
+        }
+      };
+    },
+    props: {
+      handleDOMEvents: {
+        click: function click(view) {
+          var _pluginState$lastSele, _pluginState$lastSele2;
+          var pluginState = api === null || api === void 0 ? void 0 : api.metrics.sharedState.currentState();
+          if (!pluginState || pluginState.intentToStartEditTime) {
+            return false;
+          }
+          var newSelection = view.state.tr.selection;
+          var newTr = view.state.tr;
+          if ((pluginState === null || pluginState === void 0 || (_pluginState$lastSele = pluginState.lastSelection) === null || _pluginState$lastSele === void 0 ? void 0 : _pluginState$lastSele.from) !== newSelection.from && (pluginState === null || pluginState === void 0 || (_pluginState$lastSele2 = pluginState.lastSelection) === null || _pluginState$lastSele2 === void 0 ? void 0 : _pluginState$lastSele2.to) !== newSelection.to) {
+            newTr.setMeta(metricsKey, {
+              intentToStartEditTime: performance.now(),
+              newSelection: newSelection
+            });
+            view.dispatch(newTr);
+            timer.startTimer();
+          }
+          return false;
+        }
+      }
+    }
+  });
+};

package/dist/esm/pm-plugins/utils/active-session-timer.js

@@ -0,0 +1,27 @@
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+export var ActiveSessionTimer = /*#__PURE__*/_createClass(function ActiveSessionTimer(api) {
+  var _this = this;
+  _classCallCheck(this, ActiveSessionTimer);
+  _defineProperty(this, "startTimer", function () {
+    if (_this.timerId) {
+      clearTimeout(_this.timerId);
+    }
+    _this.timerId = window.setTimeout(function () {
+      _this.cleanupTimer();
+    }, 3000);
+  });
+  _defineProperty(this, "cleanupTimer", function () {
+    if (_this.api) {
+      var _this$api$metrics;
+      _this.api.core.actions.execute((_this$api$metrics = _this.api.metrics) === null || _this$api$metrics === void 0 ? void 0 : _this$api$metrics.commands.stopActiveSession());
+    }
+    if (_this.timerId) {
+      clearTimeout(_this.timerId);
+      _this.timerId = null;
+    }
+  });
+  this.timerId = null;
+  this.api = api;
+});

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export { metricsPlugin } from './metricsPlugin';
+export type { MetricsPlugin } from './metricsPluginType';
+export type { MetricsState } from './pm-plugins/main';

package/dist/types/metricsPlugin.d.ts

@@ -0,0 +1,6 @@
+import { type MetricsPlugin } from './metricsPluginType';
+/**
+ * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export declare const metricsPlugin: MetricsPlugin;

package/dist/types/metricsPluginType.d.ts

@@ -0,0 +1,9 @@
+import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { MetricsState } from './pm-plugins/main';
+export type MetricsPlugin = NextEditorPlugin<'metrics', {
+    sharedState: MetricsState;
+    commands: {
+        stopActiveSession: () => EditorCommand;
+        fireSessionAnalytics: () => EditorCommand;
+    };
+}>;

package/dist/types/pm-plugins/main.d.ts

@@ -0,0 +1,23 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
+import { type MetricsPlugin } from '../metricsPluginType';
+export declare const metricsKey: PluginKey<any>;
+export type MetricsState = {
+    editSessionStartTime?: number;
+    intentToStartEditTime?: number;
+    activeSessionTime: number;
+    totalActionCount: number;
+    lastSelection?: Selection;
+    actionTypeCount?: ActionByType;
+    timeOfLastTextInput?: number;
+};
+export type ActionByType = {
+    textInputCount: number;
+    nodeInsertionCount: number;
+    nodeAttributeChangeCount: number;
+    contentMovedCount: number;
+    nodeDeletionCount: number;
+};
+export declare const initialPluginState: MetricsState;
+export declare const createPlugin: (api: ExtractInjectionAPI<MetricsPlugin> | undefined) => SafePlugin<MetricsState>;

package/dist/types/pm-plugins/utils/active-session-timer.d.ts

@@ -0,0 +1,9 @@
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type MetricsPlugin } from '../../metricsPluginType';
+export declare class ActiveSessionTimer {
+    private timerId;
+    private api;
+    constructor(api: ExtractInjectionAPI<MetricsPlugin> | undefined);
+    startTimer: () => void;
+    cleanupTimer: () => void;
+}

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

@@ -0,0 +1,3 @@
+export { metricsPlugin } from './metricsPlugin';
+export type { MetricsPlugin } from './metricsPluginType';
+export type { MetricsState } from './pm-plugins/main';

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

@@ -0,0 +1,6 @@
+import { type MetricsPlugin } from './metricsPluginType';
+/**
+ * Metrics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
+ * from `@atlaskit/editor-core`.
+ */
+export declare const metricsPlugin: MetricsPlugin;

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

@@ -0,0 +1,9 @@
+import type { EditorCommand, NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { MetricsState } from './pm-plugins/main';
+export type MetricsPlugin = NextEditorPlugin<'metrics', {
+    sharedState: MetricsState;
+    commands: {
+        stopActiveSession: () => EditorCommand;
+        fireSessionAnalytics: () => EditorCommand;
+    };
+}>;

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

@@ -0,0 +1,23 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { PluginKey, Selection } from '@atlaskit/editor-prosemirror/state';
+import { type MetricsPlugin } from '../metricsPluginType';
+export declare const metricsKey: PluginKey<any>;
+export type MetricsState = {
+    editSessionStartTime?: number;
+    intentToStartEditTime?: number;
+    activeSessionTime: number;
+    totalActionCount: number;
+    lastSelection?: Selection;
+    actionTypeCount?: ActionByType;
+    timeOfLastTextInput?: number;
+};
+export type ActionByType = {
+    textInputCount: number;
+    nodeInsertionCount: number;
+    nodeAttributeChangeCount: number;
+    contentMovedCount: number;
+    nodeDeletionCount: number;
+};
+export declare const initialPluginState: MetricsState;
+export declare const createPlugin: (api: ExtractInjectionAPI<MetricsPlugin> | undefined) => SafePlugin<MetricsState>;

package/dist/types-ts4.5/pm-plugins/utils/active-session-timer.d.ts

@@ -0,0 +1,9 @@
+import { type ExtractInjectionAPI } from '@atlaskit/editor-common/types';
+import { type MetricsPlugin } from '../../metricsPluginType';
+export declare class ActiveSessionTimer {
+    private timerId;
+    private api;
+    constructor(api: ExtractInjectionAPI<MetricsPlugin> | undefined);
+    startTimer: () => void;
+    cleanupTimer: () => void;
+}

package/package.json

@@ -0,0 +1,75 @@
+{
+	"name": "@atlaskit/editor-plugin-metrics",
+	"version": "1.1.0",
+	"description": "Metrics plugin for @atlaskit/editor-core",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "Editor: Jenga",
+		"singleton": true,
+		"releaseModel": "continuous",
+		"runReact18": true
+	},
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"sideEffects": false,
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts"
+	},
+	"dependencies": {
+		"@atlaskit/adf-schema": "^46.1.0",
+		"@atlaskit/editor-common": "^99.1.1",
+		"@atlaskit/editor-prosemirror": "6.2.1",
+		"@atlaskit/platform-feature-flags": "^0.3.0",
+		"@babel/runtime": "^7.0.0"
+	},
+	"peerDependencies": {
+		"react": "^16.8.0"
+	},
+	"devDependencies": {
+		"@testing-library/react": "^12.1.5",
+		"react-dom": "^16.8.0",
+		"typescript": "~5.4.2"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			],
+			"code-structure": [
+				"editor-plugin"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": [
+				"no-deprecated-imports"
+			],
+			"styling": [
+				"static"
+			]
+		}
+	}
+}