@atlaskit/editor-plugin-engagement-platform 8.0.0 → 9.0.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-engagement-platform
 
+## 9.0.1
+
+### Patch Changes
+
+- [`5985f38f7104e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5985f38f7104e) -
+  Update README.md and 0-intro.tsx
+
+## 9.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.0.0
 
 ### Patch Changes

package/README.md

@@ -1,35 +1,43 @@
-# Editor Engagement Platform Plugin
+# Editor Plugin Engagement Platform
 
-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.
+Engagement platform plugin for @atlaskit/editor-core
 
 **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
+## Overview
 
-- **Start Message**: Start an engagement message with a given ID and optional variation ID.
-- **Stop Message**: Stop an engagement message with a given ID.
+The Engagement Platform plugin provides integration with the Atlassian Engagement Platform within the editor. It enables control of external messages by allowing you to start and stop engagement messages, as well as check the state of these messages. The plugin requires a coordination client to manage message lifecycle and state.
 
-## Installation
+## Key features
 
-**Internal use only**
-
-To install the plugin, use yarn:
+- **Start message** - Start an engagement message with a given ID and optional variation ID
+- **Stop message** - Stop an engagement message with a given ID
+- **Message state tracking** - Check the active state of engagement messages
+- **Promise-based API** - Prevent duplicate requests with integrated promise management
+- **Coordination client integration** - Works with the Engagement Platform coordination client
 
-```sh
-yarn add @atlassian/editor-plugin-engagement-platform
-```
+## Install
+---
+- **Install** - *yarn add @atlaskit/editor-plugin-engagement-platform*
+- **npm** - [@atlaskit/editor-plugin-engagement-platform](https://www.npmjs.com/package/@atlaskit/editor-plugin-engagement-platform)
+- **Source** - [Bitbucket](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-engagement-platform)
+- **Bundle** - [unpkg.com](https://unpkg.com/@atlaskit/editor-plugin-engagement-platform/dist/)
 
 ## 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.
+
+Direct use of this component is not supported.
+
+### Basic setup
+
 To use the plugin, import it and include it in your editor setup:
 
 ```typescript
-import { engagementPlatformPlugin } from '@atlassian/editor-plugin-engagement-platform';
+import { engagementPlatformPlugin } from '@atlaskit/editor-plugin-engagement-platform';
 
 const coordinationClient = useCoordinationClient()
 
@@ -41,6 +49,8 @@ const { preset, editorApi } = usePreset(() => {
 }, [universalPreset, coordinationClient]);
 ```
 
+### Checking message state
+
 To get the current state of an engagement message, you can use the following code:
 
 ```typescript
@@ -50,34 +60,34 @@ function isMessageActive(messageId: string): boolean {
 }
 ```
 
-Detailed docs and example usage can be found [here](https://atlaskit.atlassian.com/packages/editor/editor-plugin-engagement-platform).
+### Plugin configuration
+
+The plugin requires a configuration object with the following structure:
+
+```typescript
+interface EngagementPlatformPluginOptions {
+	coordinationClient: CoordinationClientType;
+}
+```
 
-## API
+### API
 
-### `api.engagementPlatform.actions.startMessage(messageId: string, variationId?: string): Promise<boolean>`
+#### `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>`
+**Warning:** You must call `stopMessage` when your message has finished being displayed to a user. If you do not call `stopMessage`, your message will prevent the user from seeing any other messages until the Expiry time for the message is reached.
+
+#### `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.
 
-## Configuration
-
-The plugin requires a configuration object with the following structure:
-
-```typescript
-interface EngagementPlatformPluginOptions {
-	coordinationClient: CoordinationClientType;
-}
-```
-
 ## 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.
+---
+Please see [Atlassian Frontend - License](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) for more licensing information.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-engagement-platform",
-	"version": "8.0.0",
+	"version": "9.0.1",
 	"description": "Engagement platform plugin for @atlaskit/editor-core“",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -29,12 +29,12 @@
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/editor-plugin-analytics": "^7.0.0",
-		"@atlaskit/editor-prosemirror": "^7.2.0",
+		"@atlaskit/editor-plugin-analytics": "^8.0.0",
+		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.0.0",
+		"@atlaskit/editor-common": "^112.2.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},