@atlaskit/editor-plugin-engagement-platform 12.0.0 → 13.1.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @atlaskit/editor-plugin-engagement-platform
 
+## 13.1.0
+
+### Minor Changes
+
+- [`c98e0cf5cc4f6`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c98e0cf5cc4f6) -
+  Autofix: add explicit package exports (barrel removal)
+
+## 13.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 12.0.0
 
 ### Patch Changes

package/compass.yml

@@ -0,0 +1,41 @@
+configVersion: 1
+id: ari:cloud:compass:a436116f-02ce-4520-8fbb-7301462a1674:component/c5751cc6-3513-4070-9deb-af31e86aed34/5519bb89-825c-4220-bc20-9d4454b28639
+name: '@atlaskit/editor-plugin-engagement-platform'
+ownerId: ari:cloud:identity::team/0250ee69-f755-47fd-a468-bf8a9d10a3c5 # Editor AI
+labels:
+  - platform-code
+  - platform-afm
+typeId: OTHER
+fields:
+  tier: 4
+  lifecycle: Active
+  isMonorepoProject: true
+links:
+  - name: Root Repository
+    type: REPOSITORY
+    url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master
+  - name: Slack Channel
+    type: CHAT_CHANNEL
+    url: https://atlassian.enterprise.slack.com/archives/C03ULQ29LJ0 # #team-cc-editor-ai
+  - name: Editor Plugin Engagement Platform
+    type: REPOSITORY
+    url: https://bitbucket.org/atlassian/atlassian-frontend-monorepo/src/master/platform/packages/editor/editor-plugin-engagement-platform
+customFields:
+  - name: Department
+    type: text
+    value: Eng - Editor
+  - name: Trusted Reviewer Teams
+    type: text
+    value: ari:cloud:identity::team/cf6a670b-5252-4c68-a769-9207de366beb
+  - name: Technical Owner
+    type: user
+    value: ari:cloud:identity::user/612646c53fe26c00694fbe6a # Chris Kimber
+  - name: Required Reviewers Opt In
+    type: boolean
+    value: true
+  - name: Reviewer Selection Mechanism
+    type: text
+    value: random(2)
+  - name: Required Reviewer Approvals
+    type: number
+    value: 1

package/engagementPlatformPlugin/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-plugin-engagement-platform/engagementPlatformPlugin",
+  "main": "../dist/cjs/engagementPlatformPlugin.js",
+  "module": "../dist/esm/engagementPlatformPlugin.js",
+  "module:es2019": "../dist/es2019/engagementPlatformPlugin.js",
+  "sideEffects": false,
+  "types": "../dist/types/engagementPlatformPlugin.d.ts"
+}

package/engagementPlatformPluginType/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/editor-plugin-engagement-platform/engagementPlatformPluginType",
+  "main": "../dist/cjs/engagementPlatformPluginType.js",
+  "module": "../dist/esm/engagementPlatformPluginType.js",
+  "module:es2019": "../dist/es2019/engagementPlatformPluginType.js",
+  "sideEffects": false,
+  "types": "../dist/types/engagementPlatformPluginType.d.ts"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-engagement-platform",
-	"version": "12.0.0",
+	"version": "13.1.0",
 	"description": "Engagement platform plugin for @atlaskit/editor-core“",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -18,23 +18,15 @@
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
 	"types": "dist/types/index.d.ts",
-	"typesVersions": {
-		">=4.5 <5.4": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/editor-plugin-analytics": "^11.0.0",
-		"@atlaskit/editor-prosemirror": "^7.3.0",
+		"@atlaskit/editor-plugin-analytics": "^12.0.0",
+		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^115.0.0",
+		"@atlaskit/editor-common": "^116.25.0",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},

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

@@ -1,3 +0,0 @@
-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/editor-actions/stopMessage.d.ts

@@ -1,3 +0,0 @@
-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/editor-actions/types.d.ts

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

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

@@ -1,2 +0,0 @@
-import type { EngagementPlatformPlugin } from './engagementPlatformPluginType';
-export declare const engagementPlatformPlugin: EngagementPlatformPlugin;

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

@@ -1,91 +0,0 @@
-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 './pm-plugins/engagementPlatformPmPlugin/types';
-export type EngagementPlatformPlugin = NextEditorPlugin<'engagementPlatform', {
-    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>;
-    };
-    dependencies: [
-        OptionalPlugin<AnalyticsPlugin>
-    ];
-    pluginConfiguration: EngagementPlatformPluginOptions;
-    sharedState: EngagementPlatformPluginState;
-}>;
-/**
- * Engagement Platform coordination client.
- *
- * Product implementations should satisfy this interface.
- */
-export interface CoordinationClient {
-    start(messageId: string, variationId?: string): Promise<boolean>;
-    stop(messageId: string): Promise<boolean>;
-}
-export type EngagementPlatformPluginOptions = {
-    /**
-     * 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`
-     *
-     * Product packages provide this client implementation.
-     */
-    coordinationClient: CoordinationClient;
-    epComponents?: EpComponents;
-    epHooks?: EpHooks;
-};
-/**
- * @private
- * @deprecated Use {@link EngagementPlatformPluginOptions} instead.
- * @see https://product-fabric.atlassian.net/browse/ED-27496
- */
-export type EngagementPlatformPluginConfig = EngagementPlatformPluginOptions;
-export type EpComponents = {
-    Coordination: ComponentType<{
-        children: JSX.Element;
-        client: CoordinationClient;
-        fallback: ReactNode;
-        messageId: string;
-    }>;
-    EngagementInlineDialog: ComponentType<PropsWithChildren<{
-        engagementId: string;
-    }>>;
-    EngagementSpotlight: ComponentType<{
-        engagementId: string;
-    }>;
-};
-export type EpHooks = {
-    useCoordination: (client: CoordinationClient, messageId: string) => [
-        boolean,
-        (force?: boolean) => Promise<void>
-    ];
-};
-/** Shared state of the Engagement Platform plugin. */
-export type EngagementPlatformPluginState = EngagementPlatformPmPluginState | undefined;

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

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

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

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

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

@@ -1,3 +0,0 @@
-import type { EditorCommand } from '@atlaskit/editor-common/types';
-import type { EngagementPlatformPmPluginCommand } from './types';
-export declare const engagementPlatformPmPluginCommand: (command: EngagementPlatformPmPluginCommand) => EditorCommand;

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

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

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

@@ -1,55 +0,0 @@
-import type { CoordinationClient, EpComponents, EpHooks } from '../../engagementPlatformPluginType';
-export interface EngagementPlatformPmPluginState {
-    /** Engagement Platform coordination client */
-    coordinationClient: CoordinationClient;
-    epComponents?: EpComponents;
-    epHooks?: EpHooks;
-    /**
-     * State of Engagement Platform messages in the Editor.
-     *
-     * Contains a map of message IDs to their active state.
-     */
-    messageStates: {
-        [messageId: string]: boolean;
-    };
-    /**
-     * Promise for each message that has been started.
-     *
-     * This is used to prevent multiple start requests for the same message.
-     */
-    startMessagePromises: {
-        [messageId: string]: Promise<boolean>;
-    };
-    /**
-     * Promise for each message that has been stopped.
-     *
-     * This is used to prevent multiple stop requests for the same message.
-     */
-    stopMessagePromises: {
-        [messageId: string]: Promise<boolean>;
-    };
-}
-/** Command to EP plugin, that set state of a message with given ID. */
-export interface SetMessageStateCommand {
-    messageId: string;
-    state: boolean;
-    type: 'setMessageState';
-}
-/** Command to EP plugin, that set promise for starting a message with given ID. */
-export interface SetStartMessagePromiseCommand {
-    messageId: string;
-    promise: Promise<boolean> | undefined;
-    type: 'setStartMessagePromise';
-}
-/** Command to EP plugin, that set promise for stopping a message with given ID. */
-export interface SetStopMessagePromiseCommand {
-    messageId: string;
-    promise: Promise<boolean> | undefined;
-    type: 'setStopMessagePromise';
-}
-/** Commands that can be applied to the Engagement Platform plugin state. */
-export type EngagementPlatformPmPluginCommand = SetMessageStateCommand | SetStartMessagePromiseCommand | SetStopMessagePromiseCommand;
-export interface EngagementPlatformPmPluginTrMeta {
-    /** List of commands that should be applied to the Engagement Platform plugin state. */
-    commands: EngagementPlatformPmPluginCommand[];
-}