@atlaskit/editor-plugin-engagement-platform 2.0.0 → 2.0.1

package/CHANGELOG.md

@@ -1 +1,10 @@
 # @atlaskit/editor-plugin-engagement-platform
+
+## 2.0.1
+
+### Patch Changes
+
+- [#150384](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/150384)
+  [`704af5d7d4a1a`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/704af5d7d4a1a) -
+  [EDF-1668](https://product-fabric.atlassian.net/browse/EDF-1668) - add external message API
+  support into editor-plugin-engagement-platform

package/README.md

@@ -1,32 +1,83 @@
-# EditorPluginEngagementPlatform
+# Editor Engagement Platform Plugin
 
-Engagement platform plugin for @atlaskit/editor-core“
+This plugin allows interaction with the Atlassian Engagement Platform within the editor. It provides
+functionalities to start and stop engagement messages, as well as to check the state of these
+messages.
 
 **Note:** This component is designed for internal Atlassian development.
 External contributors will be able to use this component but will not be able to submit issues.
 
+## Features
+
+- **Start Message**: Start an engagement message with a given ID and optional variation ID.
+- **Stop Message**: Stop an engagement message with a given ID.
+
+## Installation
+
+**Internal use only**
+
+To install the plugin, use yarn:
+
+```sh
+yarn add @atlassian/editor-plugin-engagement-platform
+```
 
 ## Usage
----
+
 **Internal use only**
 
-@atlaskit/editor-plugin-engagement-platform is intended for internal use by the @atlaskit/editor-core and as a plugin dependency of the Editor within your product.
+To use the plugin, import it and include it in your editor setup:
+
+```typescript
+import { engagementPlatformPlugin } from '@atlassian/editor-plugin-engagement-platform';
+
+const coordinationClient = useCoordinationClient()
+
+const { preset, editorApi } = usePreset(() => {
+	return universalPreset.add([
+		engagementPlatformPlugin,
+		{ coordinationClient },
+	]);
+}, [universalPreset, coordinationClient]);
+```
+
+To get the current state of an engagement message, you can use the following code:
+
+```typescript
+function isMessageActive(messageId: string): boolean {
+	const messageStates = api.engagementPlatform.sharedState.currentState()?.messageStates ?? {};
+	return !!messageStates[messageId];
+}
+```
+
+Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-engagement-platform).
 
-Direct use of this component is not supported.
+## API
+
+### `api.engagementPlatform.actions.startMessage(messageId: string, variationId?: string): Promise<boolean>`
+
+Starts an engagement message with the given ID and optional variation ID.
+
+### `api.engagementPlatform.actions.stopMessage(messageId: string): Promise<boolean>`
+
+Stops an engagement message with the given ID.
 
 Please see [Atlaskit - Editor Engagement Platform Plugin](https://atlaskit.atlassian.com/packages/editor/editor-plugin-engagement-platform) for documentation and examples for this package.
 
-## Support
----
-For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
-## License
----
- Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#Platform-License) for more licensing information.
+## Configuration
 
+The plugin requires a configuration object with the following structure:
 
-## Usage
+```typescript
+interface EngagementPlatformPluginConfig {
+	coordinationClient: CoordinationClientType;
+}
+```
+
+## Support
 
-`import EditorPluginEngagementPlatform from '@atlaskit/editor-plugin-engagement-platform';`
+For internal Atlassian, visit the slack channel [#help-editor](https://atlassian.slack.com/archives/CFG3PSQ9E) for support or visit [go/editor-help](https://go/editor-help) to submit a bug.
 
+## License
 
-Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-engagement-platform).
+Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#Platform-License) for more licensing information.

package/dist/cjs/actions/startMessage.js

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.startMessage = startMessage;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _setMessageState = require("../pmPlugins/engagementPlatformPmPlugin/commands/setMessageState");
+function startMessage(api, coordinationClient) {
+  return /*#__PURE__*/function () {
+    var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(messageId, variationId) {
+      var _api$engagementPlatfo, _api$engagementPlatfo2;
+      var messageStates, isActive, isStarted, _api$analytics;
+      return _regenerator.default.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            if (api) {
+              _context.next = 2;
+              break;
+            }
+            return _context.abrupt("return", false);
+          case 2:
+            messageStates = (_api$engagementPlatfo = (_api$engagementPlatfo2 = api.engagementPlatform.sharedState.currentState()) === null || _api$engagementPlatfo2 === void 0 ? void 0 : _api$engagementPlatfo2.messageStates) !== null && _api$engagementPlatfo !== void 0 ? _api$engagementPlatfo : {};
+            isActive = messageStates[messageId];
+            if (!isActive) {
+              _context.next = 6;
+              break;
+            }
+            return _context.abrupt("return", true);
+          case 6:
+            _context.prev = 6;
+            _context.next = 9;
+            return coordinationClient.start(messageId, variationId);
+          case 9:
+            isStarted = _context.sent;
+            if (isStarted) {
+              api.core.actions.execute((0, _setMessageState.setMessageState)(messageId, true));
+            }
+            return _context.abrupt("return", isStarted);
+          case 14:
+            _context.prev = 14;
+            _context.t0 = _context["catch"](6);
+            (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+              action: _analytics.ACTION.ERRORED,
+              actionSubject: _analytics.ACTION_SUBJECT.ENGAGEMENT_PLATFORM,
+              eventType: _analytics.EVENT_TYPE.OPERATIONAL,
+              attributes: {
+                error: _context.t0 instanceof Error ? _context.t0.message : "".concat(_context.t0),
+                errorStack: _context.t0 instanceof Error ? _context.t0.stack : undefined
+              }
+            });
+            return _context.abrupt("return", false);
+          case 18:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee, null, [[6, 14]]);
+    }));
+    return function (_x, _x2) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+}

package/dist/cjs/actions/stopMessage.js

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.stopMessage = stopMessage;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _analytics = require("@atlaskit/editor-common/analytics");
+var _setMessageState = require("../pmPlugins/engagementPlatformPmPlugin/commands/setMessageState");
+function stopMessage(api, coordinationClient) {
+  return /*#__PURE__*/function () {
+    var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(messageId) {
+      var _api$engagementPlatfo, _api$engagementPlatfo2;
+      var messageStates, isActive, isStopped, _api$analytics;
+      return _regenerator.default.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            if (api) {
+              _context.next = 2;
+              break;
+            }
+            return _context.abrupt("return", false);
+          case 2:
+            messageStates = (_api$engagementPlatfo = (_api$engagementPlatfo2 = api.engagementPlatform.sharedState.currentState()) === null || _api$engagementPlatfo2 === void 0 ? void 0 : _api$engagementPlatfo2.messageStates) !== null && _api$engagementPlatfo !== void 0 ? _api$engagementPlatfo : {};
+            isActive = messageStates[messageId];
+            if (isActive) {
+              _context.next = 6;
+              break;
+            }
+            return _context.abrupt("return", true);
+          case 6:
+            _context.prev = 6;
+            _context.next = 9;
+            return coordinationClient.stop(messageId);
+          case 9:
+            isStopped = _context.sent;
+            if (isStopped) {
+              api.core.actions.execute((0, _setMessageState.setMessageState)(messageId, false));
+            }
+            return _context.abrupt("return", isStopped);
+          case 14:
+            _context.prev = 14;
+            _context.t0 = _context["catch"](6);
+            (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+              action: _analytics.ACTION.ERRORED,
+              actionSubject: _analytics.ACTION_SUBJECT.ENGAGEMENT_PLATFORM,
+              eventType: _analytics.EVENT_TYPE.OPERATIONAL,
+              attributes: {
+                error: _context.t0 instanceof Error ? _context.t0.message : "".concat(_context.t0),
+                errorStack: _context.t0 instanceof Error ? _context.t0.stack : undefined
+              }
+            });
+            return _context.abrupt("return", false);
+          case 18:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee, null, [[6, 14]]);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+}

package/dist/cjs/actions/types.js

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

package/dist/cjs/engagementPlatformPlugin.js

@@ -4,24 +4,32 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.engagementPlatformPlugin = void 0;
-var _main = require("./pm-plugins/main");
+var _startMessage = require("./actions/startMessage");
+var _stopMessage = require("./actions/stopMessage");
+var _engagementPlatformPmPlugin = require("./pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin");
+var _engagementPlatformPmPluginKey = require("./pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey");
 var engagementPlatformPlugin = exports.engagementPlatformPlugin = function engagementPlatformPlugin(_ref) {
-  var config = _ref.config;
+  var config = _ref.config,
+    api = _ref.api;
   return {
     name: 'engagementPlatform',
+    actions: {
+      startMessage: (0, _startMessage.startMessage)(api, config.coordinationClient),
+      stopMessage: (0, _stopMessage.stopMessage)(api, config.coordinationClient)
+    },
     pmPlugins: function pmPlugins() {
       return [{
-        name: 'engagementPlatform',
+        name: 'engagementPlatformPmPlugin',
         plugin: function plugin() {
-          return (0, _main.createPlugin)(config);
+          return (0, _engagementPlatformPmPlugin.engagementPlatformPmPlugin)(config);
         }
       }];
     },
     getSharedState: function getSharedState(editorState) {
-      if (!config || !editorState) {
+      if (!editorState) {
         return undefined;
       }
-      return _main.engagementPlatformPluginKey.getState(editorState);
+      return _engagementPlatformPmPluginKey.engagementPlatformPmPluginKey.getState(editorState);
     }
   };
 };

package/dist/cjs/pmPlugins/engagementPlatformPmPlugin/commands/setMessageState.js

@@ -0,0 +1,22 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.setMessageState = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _engagementPlatformPmPluginKey = require("../engagementPlatformPmPluginKey");
+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; }
+/** Set the state of a message in the Engagement Platform plugin */
+var setMessageState = exports.setMessageState = function setMessageState(messageIs, state) {
+  return function (_ref) {
+    var _tr$getMeta;
+    var tr = _ref.tr;
+    var meta = {
+      newMessageStates: _objectSpread(_objectSpread({}, (_tr$getMeta = tr.getMeta(_engagementPlatformPmPluginKey.engagementPlatformPmPluginKey)) === null || _tr$getMeta === void 0 ? void 0 : _tr$getMeta.messageStates), {}, (0, _defineProperty2.default)({}, messageIs, state))
+    };
+    return tr.setMeta(_engagementPlatformPmPluginKey.engagementPlatformPmPluginKey, meta);
+  };
+};

package/dist/cjs/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.js

@@ -0,0 +1,48 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.engagementPlatformPmPlugin = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
+var _engagementPlatformPmPluginKey = require("./engagementPlatformPmPluginKey");
+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 engagementPlatformPmPlugin = exports.engagementPlatformPmPlugin = function engagementPlatformPmPlugin(pluginConfig) {
+  return new _safePlugin.SafePlugin({
+    key: _engagementPlatformPmPluginKey.engagementPlatformPmPluginKey,
+    state: {
+      init: function init() {
+        return {
+          messageStates: {},
+          epComponents: pluginConfig.epComponents,
+          epHooks: pluginConfig.epHooks,
+          coordinationClient: pluginConfig.coordinationClient
+        };
+      },
+      apply: function apply(tr, pluginState) {
+        var meta = tr.getMeta(_engagementPlatformPmPluginKey.engagementPlatformPmPluginKey);
+        if (!meta) {
+          return pluginState;
+        }
+        var newState = _objectSpread(_objectSpread({}, pluginState), {}, {
+          messageStates: _objectSpread(_objectSpread({}, pluginState.messageStates), meta.newMessageStates)
+        });
+
+        // Remove false message states to save memory
+        Object.entries(newState.messageStates).forEach(function (_ref) {
+          var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
+            key = _ref2[0],
+            value = _ref2[1];
+          if (!value) {
+            delete newState.messageStates[key];
+          }
+        });
+        return newState;
+      }
+    }
+  });
+};

package/dist/cjs/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.engagementPlatformPmPluginKey = void 0;
+var _state = require("@atlaskit/editor-prosemirror/state");
+var engagementPlatformPmPluginKey = exports.engagementPlatformPmPluginKey = new _state.PluginKey('engagementPlatformPmPlugin');

package/dist/cjs/pmPlugins/engagementPlatformPmPlugin/types.js

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

package/dist/es2019/actions/startMessage.js

@@ -0,0 +1,34 @@
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { setMessageState } from '../pmPlugins/engagementPlatformPmPlugin/commands/setMessageState';
+export function startMessage(api, coordinationClient) {
+  return async (messageId, variationId) => {
+    var _api$engagementPlatfo, _api$engagementPlatfo2;
+    if (!api) {
+      return false;
+    }
+    const messageStates = (_api$engagementPlatfo = (_api$engagementPlatfo2 = api.engagementPlatform.sharedState.currentState()) === null || _api$engagementPlatfo2 === void 0 ? void 0 : _api$engagementPlatfo2.messageStates) !== null && _api$engagementPlatfo !== void 0 ? _api$engagementPlatfo : {};
+    const isActive = messageStates[messageId];
+    if (isActive) {
+      return true;
+    }
+    try {
+      const isStarted = await coordinationClient.start(messageId, variationId);
+      if (isStarted) {
+        api.core.actions.execute(setMessageState(messageId, true));
+      }
+      return isStarted;
+    } catch (error) {
+      var _api$analytics;
+      (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent({
+        action: ACTION.ERRORED,
+        actionSubject: ACTION_SUBJECT.ENGAGEMENT_PLATFORM,
+        eventType: EVENT_TYPE.OPERATIONAL,
+        attributes: {
+          error: error instanceof Error ? error.message : `${error}`,
+          errorStack: error instanceof Error ? error.stack : undefined
+        }
+      });
+      return false;
+    }
+  };
+}

package/dist/es2019/actions/stopMessage.js

@@ -0,0 +1,34 @@
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { setMessageState } from '../pmPlugins/engagementPlatformPmPlugin/commands/setMessageState';
+export function stopMessage(api, coordinationClient) {
+  return async messageId => {
+    var _api$engagementPlatfo, _api$engagementPlatfo2;
+    if (!api) {
+      return false;
+    }
+    const messageStates = (_api$engagementPlatfo = (_api$engagementPlatfo2 = api.engagementPlatform.sharedState.currentState()) === null || _api$engagementPlatfo2 === void 0 ? void 0 : _api$engagementPlatfo2.messageStates) !== null && _api$engagementPlatfo !== void 0 ? _api$engagementPlatfo : {};
+    const isActive = messageStates[messageId];
+    if (!isActive) {
+      return true;
+    }
+    try {
+      const isStopped = await coordinationClient.stop(messageId);
+      if (isStopped) {
+        api.core.actions.execute(setMessageState(messageId, false));
+      }
+      return isStopped;
+    } catch (error) {
+      var _api$analytics;
+      (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.actions.fireAnalyticsEvent({
+        action: ACTION.ERRORED,
+        actionSubject: ACTION_SUBJECT.ENGAGEMENT_PLATFORM,
+        eventType: EVENT_TYPE.OPERATIONAL,
+        attributes: {
+          error: error instanceof Error ? error.message : `${error}`,
+          errorStack: error instanceof Error ? error.stack : undefined
+        }
+      });
+      return false;
+    }
+  };
+}

package/dist/es2019/actions/types.js

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

package/dist/es2019/engagementPlatformPlugin.js

@@ -1,20 +1,28 @@
-import { createPlugin, engagementPlatformPluginKey } from './pm-plugins/main';
+import { startMessage } from './actions/startMessage';
+import { stopMessage } from './actions/stopMessage';
+import { engagementPlatformPmPlugin } from './pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin';
+import { engagementPlatformPmPluginKey } from './pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey';
 export const engagementPlatformPlugin = ({
-  config
+  config,
+  api
 }) => {
   return {
     name: 'engagementPlatform',
+    actions: {
+      startMessage: startMessage(api, config.coordinationClient),
+      stopMessage: stopMessage(api, config.coordinationClient)
+    },
     pmPlugins() {
       return [{
-        name: 'engagementPlatform',
-        plugin: () => createPlugin(config)
+        name: 'engagementPlatformPmPlugin',
+        plugin: () => engagementPlatformPmPlugin(config)
       }];
     },
     getSharedState(editorState) {
-      if (!config || !editorState) {
+      if (!editorState) {
         return undefined;
       }
-      return engagementPlatformPluginKey.getState(editorState);
+      return engagementPlatformPmPluginKey.getState(editorState);
     }
   };
 };

package/dist/es2019/pmPlugins/engagementPlatformPmPlugin/commands/setMessageState.js

@@ -0,0 +1,14 @@
+import { engagementPlatformPmPluginKey } from '../engagementPlatformPmPluginKey';
+/** Set the state of a message in the Engagement Platform plugin */
+export const setMessageState = (messageIs, state) => ({
+  tr
+}) => {
+  var _tr$getMeta;
+  const meta = {
+    newMessageStates: {
+      ...((_tr$getMeta = tr.getMeta(engagementPlatformPmPluginKey)) === null || _tr$getMeta === void 0 ? void 0 : _tr$getMeta.messageStates),
+      [messageIs]: state
+    }
+  };
+  return tr.setMeta(engagementPlatformPmPluginKey, meta);
+};

package/dist/es2019/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.js

@@ -0,0 +1,38 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { engagementPlatformPmPluginKey } from './engagementPlatformPmPluginKey';
+export const engagementPlatformPmPlugin = pluginConfig => {
+  return new SafePlugin({
+    key: engagementPlatformPmPluginKey,
+    state: {
+      init: () => {
+        return {
+          messageStates: {},
+          epComponents: pluginConfig.epComponents,
+          epHooks: pluginConfig.epHooks,
+          coordinationClient: pluginConfig.coordinationClient
+        };
+      },
+      apply: (tr, pluginState) => {
+        const meta = tr.getMeta(engagementPlatformPmPluginKey);
+        if (!meta) {
+          return pluginState;
+        }
+        const newState = {
+          ...pluginState,
+          messageStates: {
+            ...pluginState.messageStates,
+            ...meta.newMessageStates
+          }
+        };
+
+        // Remove false message states to save memory
+        Object.entries(newState.messageStates).forEach(([key, value]) => {
+          if (!value) {
+            delete newState.messageStates[key];
+          }
+        });
+        return newState;
+      }
+    }
+  });
+};

package/dist/es2019/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey.js

@@ -0,0 +1,2 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export const engagementPlatformPmPluginKey = new PluginKey('engagementPlatformPmPlugin');

package/dist/es2019/pmPlugins/engagementPlatformPmPlugin/types.js

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

package/dist/esm/actions/startMessage.js

@@ -0,0 +1,59 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { setMessageState } from '../pmPlugins/engagementPlatformPmPlugin/commands/setMessageState';
+export function startMessage(api, coordinationClient) {
+  return /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(messageId, variationId) {
+      var _api$engagementPlatfo, _api$engagementPlatfo2;
+      var messageStates, isActive, isStarted, _api$analytics;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            if (api) {
+              _context.next = 2;
+              break;
+            }
+            return _context.abrupt("return", false);
+          case 2:
+            messageStates = (_api$engagementPlatfo = (_api$engagementPlatfo2 = api.engagementPlatform.sharedState.currentState()) === null || _api$engagementPlatfo2 === void 0 ? void 0 : _api$engagementPlatfo2.messageStates) !== null && _api$engagementPlatfo !== void 0 ? _api$engagementPlatfo : {};
+            isActive = messageStates[messageId];
+            if (!isActive) {
+              _context.next = 6;
+              break;
+            }
+            return _context.abrupt("return", true);
+          case 6:
+            _context.prev = 6;
+            _context.next = 9;
+            return coordinationClient.start(messageId, variationId);
+          case 9:
+            isStarted = _context.sent;
+            if (isStarted) {
+              api.core.actions.execute(setMessageState(messageId, true));
+            }
+            return _context.abrupt("return", isStarted);
+          case 14:
+            _context.prev = 14;
+            _context.t0 = _context["catch"](6);
+            (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+              action: ACTION.ERRORED,
+              actionSubject: ACTION_SUBJECT.ENGAGEMENT_PLATFORM,
+              eventType: EVENT_TYPE.OPERATIONAL,
+              attributes: {
+                error: _context.t0 instanceof Error ? _context.t0.message : "".concat(_context.t0),
+                errorStack: _context.t0 instanceof Error ? _context.t0.stack : undefined
+              }
+            });
+            return _context.abrupt("return", false);
+          case 18:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee, null, [[6, 14]]);
+    }));
+    return function (_x, _x2) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+}

package/dist/esm/actions/stopMessage.js

@@ -0,0 +1,59 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { ACTION, ACTION_SUBJECT, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
+import { setMessageState } from '../pmPlugins/engagementPlatformPmPlugin/commands/setMessageState';
+export function stopMessage(api, coordinationClient) {
+  return /*#__PURE__*/function () {
+    var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(messageId) {
+      var _api$engagementPlatfo, _api$engagementPlatfo2;
+      var messageStates, isActive, isStopped, _api$analytics;
+      return _regeneratorRuntime.wrap(function _callee$(_context) {
+        while (1) switch (_context.prev = _context.next) {
+          case 0:
+            if (api) {
+              _context.next = 2;
+              break;
+            }
+            return _context.abrupt("return", false);
+          case 2:
+            messageStates = (_api$engagementPlatfo = (_api$engagementPlatfo2 = api.engagementPlatform.sharedState.currentState()) === null || _api$engagementPlatfo2 === void 0 ? void 0 : _api$engagementPlatfo2.messageStates) !== null && _api$engagementPlatfo !== void 0 ? _api$engagementPlatfo : {};
+            isActive = messageStates[messageId];
+            if (isActive) {
+              _context.next = 6;
+              break;
+            }
+            return _context.abrupt("return", true);
+          case 6:
+            _context.prev = 6;
+            _context.next = 9;
+            return coordinationClient.stop(messageId);
+          case 9:
+            isStopped = _context.sent;
+            if (isStopped) {
+              api.core.actions.execute(setMessageState(messageId, false));
+            }
+            return _context.abrupt("return", isStopped);
+          case 14:
+            _context.prev = 14;
+            _context.t0 = _context["catch"](6);
+            (_api$analytics = api.analytics) === null || _api$analytics === void 0 || _api$analytics.actions.fireAnalyticsEvent({
+              action: ACTION.ERRORED,
+              actionSubject: ACTION_SUBJECT.ENGAGEMENT_PLATFORM,
+              eventType: EVENT_TYPE.OPERATIONAL,
+              attributes: {
+                error: _context.t0 instanceof Error ? _context.t0.message : "".concat(_context.t0),
+                errorStack: _context.t0 instanceof Error ? _context.t0.stack : undefined
+              }
+            });
+            return _context.abrupt("return", false);
+          case 18:
+          case "end":
+            return _context.stop();
+        }
+      }, _callee, null, [[6, 14]]);
+    }));
+    return function (_x) {
+      return _ref.apply(this, arguments);
+    };
+  }();
+}

package/dist/esm/actions/types.js

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

package/dist/esm/engagementPlatformPlugin.js

@@ -1,21 +1,29 @@
-import { createPlugin, engagementPlatformPluginKey } from './pm-plugins/main';
+import { startMessage } from './actions/startMessage';
+import { stopMessage } from './actions/stopMessage';
+import { engagementPlatformPmPlugin } from './pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin';
+import { engagementPlatformPmPluginKey } from './pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey';
 export var engagementPlatformPlugin = function engagementPlatformPlugin(_ref) {
-  var config = _ref.config;
+  var config = _ref.config,
+    api = _ref.api;
   return {
     name: 'engagementPlatform',
+    actions: {
+      startMessage: startMessage(api, config.coordinationClient),
+      stopMessage: stopMessage(api, config.coordinationClient)
+    },
     pmPlugins: function pmPlugins() {
       return [{
-        name: 'engagementPlatform',
+        name: 'engagementPlatformPmPlugin',
         plugin: function plugin() {
-          return createPlugin(config);
+          return engagementPlatformPmPlugin(config);
         }
       }];
     },
     getSharedState: function getSharedState(editorState) {
-      if (!config || !editorState) {
+      if (!editorState) {
         return undefined;
       }
-      return engagementPlatformPluginKey.getState(editorState);
+      return engagementPlatformPmPluginKey.getState(editorState);
     }
   };
 };

package/dist/esm/pmPlugins/engagementPlatformPmPlugin/commands/setMessageState.js

@@ -0,0 +1,15 @@
+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 { engagementPlatformPmPluginKey } from '../engagementPlatformPmPluginKey';
+/** Set the state of a message in the Engagement Platform plugin */
+export var setMessageState = function setMessageState(messageIs, state) {
+  return function (_ref) {
+    var _tr$getMeta;
+    var tr = _ref.tr;
+    var meta = {
+      newMessageStates: _objectSpread(_objectSpread({}, (_tr$getMeta = tr.getMeta(engagementPlatformPmPluginKey)) === null || _tr$getMeta === void 0 ? void 0 : _tr$getMeta.messageStates), {}, _defineProperty({}, messageIs, state))
+    };
+    return tr.setMeta(engagementPlatformPmPluginKey, meta);
+  };
+};

package/dist/esm/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.js

@@ -0,0 +1,41 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+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 { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import { engagementPlatformPmPluginKey } from './engagementPlatformPmPluginKey';
+export var engagementPlatformPmPlugin = function engagementPlatformPmPlugin(pluginConfig) {
+  return new SafePlugin({
+    key: engagementPlatformPmPluginKey,
+    state: {
+      init: function init() {
+        return {
+          messageStates: {},
+          epComponents: pluginConfig.epComponents,
+          epHooks: pluginConfig.epHooks,
+          coordinationClient: pluginConfig.coordinationClient
+        };
+      },
+      apply: function apply(tr, pluginState) {
+        var meta = tr.getMeta(engagementPlatformPmPluginKey);
+        if (!meta) {
+          return pluginState;
+        }
+        var newState = _objectSpread(_objectSpread({}, pluginState), {}, {
+          messageStates: _objectSpread(_objectSpread({}, pluginState.messageStates), meta.newMessageStates)
+        });
+
+        // Remove false message states to save memory
+        Object.entries(newState.messageStates).forEach(function (_ref) {
+          var _ref2 = _slicedToArray(_ref, 2),
+            key = _ref2[0],
+            value = _ref2[1];
+          if (!value) {
+            delete newState.messageStates[key];
+          }
+        });
+        return newState;
+      }
+    }
+  });
+};

package/dist/esm/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey.js

@@ -0,0 +1,2 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+export var engagementPlatformPmPluginKey = new PluginKey('engagementPlatformPmPlugin');

package/dist/esm/pmPlugins/engagementPlatformPmPlugin/types.js

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

package/dist/types/actions/startMessage.d.ts

@@ -0,0 +1,3 @@
+import type { CoordinationClient } from '../engagementPlatformPluginType';
+import type { EngagementPlatformPluginApi } from './types';
+export declare function startMessage(api: EngagementPlatformPluginApi | undefined, coordinationClient: CoordinationClient): (messageId: string, variationId?: string) => Promise<boolean>;

package/dist/types/actions/stopMessage.d.ts

@@ -0,0 +1,3 @@
+import type { CoordinationClient } from '../engagementPlatformPluginType';
+import type { EngagementPlatformPluginApi } from './types';
+export declare function stopMessage(api: EngagementPlatformPluginApi | undefined, coordinationClient: CoordinationClient): (messageId: string) => Promise<boolean>;

package/dist/types/actions/types.d.ts

@@ -0,0 +1,2 @@
+import type { EngagementPlatformPlugin } from '../engagementPlatformPluginType';
+export type EngagementPlatformPluginApi = Parameters<EngagementPlatformPlugin>[0]['api'];

package/dist/types/engagementPlatformPluginType.d.ts

@@ -1,28 +1,74 @@
-import type { PropsWithChildren, ReactNode } from 'react';
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { ComponentType, PropsWithChildren, ReactNode } from 'react';
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EngagementPlatformPmPluginState } from './pmPlugins/engagementPlatformPmPlugin/types';
 export type EngagementPlatformPlugin = NextEditorPlugin<'engagementPlatform', {
-    pluginConfiguration: EngagementPlatformPluginOptions;
-    dependencies: [];
+    actions: {
+        /**
+         * Start an Engagement Platform external message with given ID and optional variation ID.
+         *
+         * This API action requires the `coordinationClient` to be provided in the plugin configuration.
+         *
+         * WARNING: Don't forget to STOP
+         *
+         * You must call {@link stopMessage} when your message has finished being displayed to a user.
+         * If you do not call {@link stopMessage}, your message will prevent the user from seeing any other
+         * messages until the Expiry time for the message is reached.
+         *
+         * @see https://developer.atlassian.com/platform/personalization/engagement/guides/external/create-external-message/#using-the-lower-level-react-class-directly---coordinationclient
+         */
+        startMessage: (messageId: string, variationId?: string) => Promise<boolean>;
+        /**
+         * Stop an Engagement Platform external message with given ID.
+         *
+         * This API action requires the `coordinationClient` to be provided in the plugin configuration.
+         *
+         * @see https://developer.atlassian.com/platform/personalization/engagement/guides/external/create-external-message/#using-the-lower-level-react-class-directly---coordinationclient
+         */
+        stopMessage: (messageId: string) => Promise<boolean>;
+    };
+    pluginConfiguration: EngagementPlatformPluginConfig;
+    dependencies: [OptionalPlugin<AnalyticsPlugin>];
     sharedState: EngagementPlatformPluginState;
 }>;
+/**
+ * Engagement Platform coordination client.
+ *
+ * This type should be the same as the `CoordinationClientType`
+ * from the `@atlassiansox/engagekit-ts` package.
+ */
 export interface CoordinationClient {
     start(messageId: string, variationId?: string): Promise<boolean>;
     stop(messageId: string): Promise<boolean>;
 }
-export type EngagementPlatformPluginOptions = {
+export type EngagementPlatformPluginConfig = {
     epComponents: EpComponents;
     epHooks: EpHooks;
+    /**
+     * Engagement Platform API client.
+     *
+     * This client is used to start and stop external messages in the Engagement Platform.
+     * It should be provided by a product.
+     *
+     * Without this client the next Engagement Platform plugin api calls will not work:
+     * - `startMessage`
+     * - `stopMessage`
+     * - `getMessageActivities`
+     * - `isMessageActive`
+     *
+     * The client lives in the `@atlassiansox/engagekit-ts` package.
+     */
     coordinationClient: CoordinationClient;
 };
 export type EpComponents = {
-    EngagementProvider: React.ComponentType<PropsWithChildren<{}>>;
-    EngagementSpotlight: React.ComponentType<{
+    EngagementProvider: ComponentType<PropsWithChildren<{}>>;
+    EngagementSpotlight: ComponentType<{
         engagementId: string;
     }>;
-    EngagementInlineDialog: React.ComponentType<PropsWithChildren<{
+    EngagementInlineDialog: ComponentType<PropsWithChildren<{
         engagementId: string;
     }>>;
-    Coordination: React.ComponentType<PropsWithChildren<{
+    Coordination: ComponentType<PropsWithChildren<{
         client: CoordinationClient;
         messageId: string;
         fallback: ReactNode;
@@ -31,8 +77,5 @@ export type EpComponents = {
 export type EpHooks = {
     useCoordination: (client: CoordinationClient, messageId: string) => [boolean, (force?: boolean) => Promise<void>];
 };
-export type EngagementPlatformPluginState = {
-    epComponents: EpComponents;
-    epHooks: EpHooks;
-    coordinationClient: CoordinationClient;
-} | undefined;
+/** Shared state of the Engagement Platform plugin. */
+export type EngagementPlatformPluginState = EngagementPlatformPmPluginState | undefined;

package/dist/types/index.d.ts

@@ -1,2 +1,2 @@
 export { engagementPlatformPlugin } from './engagementPlatformPlugin';
-export type { EngagementPlatformPlugin, EngagementPlatformPluginOptions, EpComponents, EpHooks, CoordinationClient, } from './engagementPlatformPluginType';
+export type { EngagementPlatformPlugin, EngagementPlatformPluginConfig, EpComponents, EpHooks, CoordinationClient, } from './engagementPlatformPluginType';

package/dist/types/pmPlugins/engagementPlatformPmPlugin/commands/setMessageState.d.ts

@@ -0,0 +1,3 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+/** Set the state of a message in the Engagement Platform plugin */
+export declare const setMessageState: (messageIs: string, state: boolean) => EditorCommand;

package/dist/types/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.d.ts

@@ -0,0 +1,4 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { EngagementPlatformPluginConfig } from '../../engagementPlatformPluginType';
+import type { EngagementPlatformPmPluginState } from './types';
+export declare const engagementPlatformPmPlugin: (pluginConfig: EngagementPlatformPluginConfig) => SafePlugin<EngagementPlatformPmPluginState>;

package/dist/types/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey.d.ts

@@ -0,0 +1,3 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EngagementPlatformPluginState } from '../../engagementPlatformPluginType';
+export declare const engagementPlatformPmPluginKey: PluginKey<EngagementPlatformPluginState>;

package/dist/types/pmPlugins/engagementPlatformPmPlugin/types.d.ts

@@ -0,0 +1,25 @@
+import type { CoordinationClient, EpComponents, EpHooks } from '../../engagementPlatformPluginType';
+export interface EngagementPlatformPmPluginState {
+    /**
+     * State of Engagement Platform messages in the Editor.
+     *
+     * Contains a map of message IDs to their active state.
+     */
+    messageStates: {
+        [messageId: string]: boolean;
+    };
+    /** Engagement Platform coordination client */
+    coordinationClient: CoordinationClient;
+    epComponents: EpComponents;
+    epHooks: EpHooks;
+}
+export interface EngagementPlatformPmPluginTrMeta {
+    /**
+     * New state of Engagement Platform messages in the Editor.
+     *
+     * This state will be merged (NOT REPLACED) with the existing state.
+     */
+    newMessageStates: {
+        [messageId: string]: boolean;
+    };
+}

package/dist/types-ts4.5/actions/startMessage.d.ts

@@ -0,0 +1,3 @@
+import type { CoordinationClient } from '../engagementPlatformPluginType';
+import type { EngagementPlatformPluginApi } from './types';
+export declare function startMessage(api: EngagementPlatformPluginApi | undefined, coordinationClient: CoordinationClient): (messageId: string, variationId?: string) => Promise<boolean>;

package/dist/types-ts4.5/actions/stopMessage.d.ts

@@ -0,0 +1,3 @@
+import type { CoordinationClient } from '../engagementPlatformPluginType';
+import type { EngagementPlatformPluginApi } from './types';
+export declare function stopMessage(api: EngagementPlatformPluginApi | undefined, coordinationClient: CoordinationClient): (messageId: string) => Promise<boolean>;

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

@@ -0,0 +1,2 @@
+import type { EngagementPlatformPlugin } from '../engagementPlatformPluginType';
+export type EngagementPlatformPluginApi = Parameters<EngagementPlatformPlugin>[0]['api'];

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

@@ -1,29 +1,76 @@
-import type { PropsWithChildren, ReactNode } from 'react';
-import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
+import type { ComponentType, PropsWithChildren, ReactNode } from 'react';
+import type { NextEditorPlugin, OptionalPlugin } from '@atlaskit/editor-common/types';
+import type { AnalyticsPlugin } from '@atlaskit/editor-plugin-analytics';
+import type { EngagementPlatformPmPluginState } from './pmPlugins/engagementPlatformPmPlugin/types';
 export type EngagementPlatformPlugin = NextEditorPlugin<'engagementPlatform', {
-    pluginConfiguration: EngagementPlatformPluginOptions;
+    actions: {
+        /**
+         * Start an Engagement Platform external message with given ID and optional variation ID.
+         *
+         * This API action requires the `coordinationClient` to be provided in the plugin configuration.
+         *
+         * WARNING: Don't forget to STOP
+         *
+         * You must call {@link stopMessage} when your message has finished being displayed to a user.
+         * If you do not call {@link stopMessage}, your message will prevent the user from seeing any other
+         * messages until the Expiry time for the message is reached.
+         *
+         * @see https://developer.atlassian.com/platform/personalization/engagement/guides/external/create-external-message/#using-the-lower-level-react-class-directly---coordinationclient
+         */
+        startMessage: (messageId: string, variationId?: string) => Promise<boolean>;
+        /**
+         * Stop an Engagement Platform external message with given ID.
+         *
+         * This API action requires the `coordinationClient` to be provided in the plugin configuration.
+         *
+         * @see https://developer.atlassian.com/platform/personalization/engagement/guides/external/create-external-message/#using-the-lower-level-react-class-directly---coordinationclient
+         */
+        stopMessage: (messageId: string) => Promise<boolean>;
+    };
+    pluginConfiguration: EngagementPlatformPluginConfig;
     dependencies: [
+        OptionalPlugin<AnalyticsPlugin>
     ];
     sharedState: EngagementPlatformPluginState;
 }>;
+/**
+ * Engagement Platform coordination client.
+ *
+ * This type should be the same as the `CoordinationClientType`
+ * from the `@atlassiansox/engagekit-ts` package.
+ */
 export interface CoordinationClient {
     start(messageId: string, variationId?: string): Promise<boolean>;
     stop(messageId: string): Promise<boolean>;
 }
-export type EngagementPlatformPluginOptions = {
+export type EngagementPlatformPluginConfig = {
     epComponents: EpComponents;
     epHooks: EpHooks;
+    /**
+     * Engagement Platform API client.
+     *
+     * This client is used to start and stop external messages in the Engagement Platform.
+     * It should be provided by a product.
+     *
+     * Without this client the next Engagement Platform plugin api calls will not work:
+     * - `startMessage`
+     * - `stopMessage`
+     * - `getMessageActivities`
+     * - `isMessageActive`
+     *
+     * The client lives in the `@atlassiansox/engagekit-ts` package.
+     */
     coordinationClient: CoordinationClient;
 };
 export type EpComponents = {
-    EngagementProvider: React.ComponentType<PropsWithChildren<{}>>;
-    EngagementSpotlight: React.ComponentType<{
+    EngagementProvider: ComponentType<PropsWithChildren<{}>>;
+    EngagementSpotlight: ComponentType<{
         engagementId: string;
     }>;
-    EngagementInlineDialog: React.ComponentType<PropsWithChildren<{
+    EngagementInlineDialog: ComponentType<PropsWithChildren<{
         engagementId: string;
     }>>;
-    Coordination: React.ComponentType<PropsWithChildren<{
+    Coordination: ComponentType<PropsWithChildren<{
         client: CoordinationClient;
         messageId: string;
         fallback: ReactNode;
@@ -35,8 +82,5 @@ export type EpHooks = {
         (force?: boolean) => Promise<void>
     ];
 };
-export type EngagementPlatformPluginState = {
-    epComponents: EpComponents;
-    epHooks: EpHooks;
-    coordinationClient: CoordinationClient;
-} | undefined;
+/** Shared state of the Engagement Platform plugin. */
+export type EngagementPlatformPluginState = EngagementPlatformPmPluginState | undefined;

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

@@ -1,2 +1,2 @@
 export { engagementPlatformPlugin } from './engagementPlatformPlugin';
-export type { EngagementPlatformPlugin, EngagementPlatformPluginOptions, EpComponents, EpHooks, CoordinationClient, } from './engagementPlatformPluginType';
+export type { EngagementPlatformPlugin, EngagementPlatformPluginConfig, EpComponents, EpHooks, CoordinationClient, } from './engagementPlatformPluginType';

package/dist/types-ts4.5/pmPlugins/engagementPlatformPmPlugin/commands/setMessageState.d.ts

@@ -0,0 +1,3 @@
+import type { EditorCommand } from '@atlaskit/editor-common/types';
+/** Set the state of a message in the Engagement Platform plugin */
+export declare const setMessageState: (messageIs: string, state: boolean) => EditorCommand;

package/dist/types-ts4.5/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.d.ts

@@ -0,0 +1,4 @@
+import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
+import type { EngagementPlatformPluginConfig } from '../../engagementPlatformPluginType';
+import type { EngagementPlatformPmPluginState } from './types';
+export declare const engagementPlatformPmPlugin: (pluginConfig: EngagementPlatformPluginConfig) => SafePlugin<EngagementPlatformPmPluginState>;

package/dist/types-ts4.5/pmPlugins/engagementPlatformPmPlugin/engagementPlatformPmPluginKey.d.ts

@@ -0,0 +1,3 @@
+import { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EngagementPlatformPluginState } from '../../engagementPlatformPluginType';
+export declare const engagementPlatformPmPluginKey: PluginKey<EngagementPlatformPluginState>;

package/dist/types-ts4.5/pmPlugins/engagementPlatformPmPlugin/types.d.ts

@@ -0,0 +1,25 @@
+import type { CoordinationClient, EpComponents, EpHooks } from '../../engagementPlatformPluginType';
+export interface EngagementPlatformPmPluginState {
+    /**
+     * State of Engagement Platform messages in the Editor.
+     *
+     * Contains a map of message IDs to their active state.
+     */
+    messageStates: {
+        [messageId: string]: boolean;
+    };
+    /** Engagement Platform coordination client */
+    coordinationClient: CoordinationClient;
+    epComponents: EpComponents;
+    epHooks: EpHooks;
+}
+export interface EngagementPlatformPmPluginTrMeta {
+    /**
+     * New state of Engagement Platform messages in the Editor.
+     *
+     * This state will be merged (NOT REPLACED) with the existing state.
+     */
+    newMessageStates: {
+        [messageId: string]: boolean;
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-engagement-platform",
-	"version": "2.0.0",
+	"version": "2.0.1",
 	"description": "Engagement platform plugin for @atlaskit/editor-core“",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -34,6 +34,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/editor-common": "^93.1.0",
+		"@atlaskit/editor-plugin-analytics": "^1.8.0",
 		"@atlaskit/editor-prosemirror": "6.0.0",
 		"@babel/runtime": "^7.0.0"
 	},

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

@@ -1,29 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.engagementPlatformPluginKey = exports.createPlugin = void 0;
-var _safePlugin = require("@atlaskit/editor-common/safe-plugin");
-var _state = require("@atlaskit/editor-prosemirror/state");
-var engagementPlatformPluginKey = exports.engagementPlatformPluginKey = new _state.PluginKey('engagementPlatformPlugin');
-var createPlugin = exports.createPlugin = function createPlugin(pluginOptions) {
-  return new _safePlugin.SafePlugin({
-    key: engagementPlatformPluginKey,
-    state: {
-      init: function init() {
-        if (!pluginOptions) {
-          return undefined;
-        }
-        return {
-          epComponents: pluginOptions.epComponents,
-          epHooks: pluginOptions.epHooks,
-          coordinationClient: pluginOptions.coordinationClient
-        };
-      },
-      apply: function apply(_tr, pluginState) {
-        return pluginState;
-      }
-    }
-  });
-};

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

@@ -1,23 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-export const engagementPlatformPluginKey = new PluginKey('engagementPlatformPlugin');
-export const createPlugin = pluginOptions => {
-  return new SafePlugin({
-    key: engagementPlatformPluginKey,
-    state: {
-      init: () => {
-        if (!pluginOptions) {
-          return undefined;
-        }
-        return {
-          epComponents: pluginOptions.epComponents,
-          epHooks: pluginOptions.epHooks,
-          coordinationClient: pluginOptions.coordinationClient
-        };
-      },
-      apply: (_tr, pluginState) => {
-        return pluginState;
-      }
-    }
-  });
-};

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

@@ -1,23 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-export var engagementPlatformPluginKey = new PluginKey('engagementPlatformPlugin');
-export var createPlugin = function createPlugin(pluginOptions) {
-  return new SafePlugin({
-    key: engagementPlatformPluginKey,
-    state: {
-      init: function init() {
-        if (!pluginOptions) {
-          return undefined;
-        }
-        return {
-          epComponents: pluginOptions.epComponents,
-          epHooks: pluginOptions.epHooks,
-          coordinationClient: pluginOptions.coordinationClient
-        };
-      },
-      apply: function apply(_tr, pluginState) {
-        return pluginState;
-      }
-    }
-  });
-};

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

@@ -1,9 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { EngagementPlatformPluginOptions, EngagementPlatformPluginState } from '../engagementPlatformPluginType';
-export declare const engagementPlatformPluginKey: PluginKey<EngagementPlatformPluginState>;
-export declare const createPlugin: (pluginOptions: EngagementPlatformPluginOptions) => SafePlugin<{
-    epComponents: import("../engagementPlatformPluginType").EpComponents;
-    epHooks: import("../engagementPlatformPluginType").EpHooks;
-    coordinationClient: import("../engagementPlatformPluginType").CoordinationClient;
-} | undefined>;

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

@@ -1,9 +0,0 @@
-import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
-import { PluginKey } from '@atlaskit/editor-prosemirror/state';
-import type { EngagementPlatformPluginOptions, EngagementPlatformPluginState } from '../engagementPlatformPluginType';
-export declare const engagementPlatformPluginKey: PluginKey<EngagementPlatformPluginState>;
-export declare const createPlugin: (pluginOptions: EngagementPlatformPluginOptions) => SafePlugin<{
-    epComponents: import("../engagementPlatformPluginType").EpComponents;
-    epHooks: import("../engagementPlatformPluginType").EpHooks;
-    coordinationClient: import("../engagementPlatformPluginType").CoordinationClient;
-} | undefined>;