@atlaskit/editor-plugin-engagement-platform 3.0.3 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/README.md +1 -1
  3. package/dist/types/engagementPlatformPluginType.d.ts +8 -2
  4. package/dist/types/index.d.ts +1 -1
  5. package/dist/types/pm-plugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.d.ts +2 -2
  6. package/dist/types-ts4.5/engagementPlatformPluginType.d.ts +8 -2
  7. package/dist/types-ts4.5/index.d.ts +1 -1
  8. package/dist/types-ts4.5/pm-plugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.d.ts +2 -2
  9. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # @atlaskit/editor-plugin-engagement-platform
2
2
 
3
+ ## 3.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [#139139](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/139139)
8
+ [`7f6b665d778dd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7f6b665d778dd) -
9
+ [https://product-fabric.atlassian.net/browse/ED-27499](ED-27499) - the new
10
+ `@atlassian/confluence-presets` package with Confluence `full-page` preset is created
11
+
12
+ ### Patch Changes
13
+
14
+ - Updated dependencies
15
+
3
16
  ## 3.0.3
4
17
 
5
18
  ### Patch Changes
package/README.md CHANGED
@@ -69,7 +69,7 @@ Please see [Atlaskit - Editor Engagement Platform Plugin](https://atlaskit.atlas
69
69
  The plugin requires a configuration object with the following structure:
70
70
 
71
71
  ```typescript
72
- interface EngagementPlatformPluginConfig {
72
+ interface EngagementPlatformPluginOptions {
73
73
  coordinationClient: CoordinationClientType;
74
74
  }
75
75
  ```
package/dist/types/engagementPlatformPluginType.d.ts CHANGED
@@ -27,7 +27,7 @@ export type EngagementPlatformPlugin = NextEditorPlugin<'engagementPlatform', {
27
27
  */
28
28
  stopMessage: (messageId: string) => Promise<boolean>;
29
29
  };
30
- pluginConfiguration: EngagementPlatformPluginConfig;
30
+ pluginConfiguration: EngagementPlatformPluginOptions;
31
31
  dependencies: [OptionalPlugin<AnalyticsPlugin>];
32
32
  sharedState: EngagementPlatformPluginState;
33
33
  }>;
@@ -41,7 +41,7 @@ export interface CoordinationClient {
41
41
  start(messageId: string, variationId?: string): Promise<boolean>;
42
42
  stop(messageId: string): Promise<boolean>;
43
43
  }
44
- export type EngagementPlatformPluginConfig = {
44
+ export type EngagementPlatformPluginOptions = {
45
45
  epComponents: EpComponents;
46
46
  epHooks: EpHooks;
47
47
  /**
@@ -60,6 +60,12 @@ export type EngagementPlatformPluginConfig = {
60
60
  */
61
61
  coordinationClient: CoordinationClient;
62
62
  };
63
+ /**
64
+ * @private
65
+ * @deprecated Use {@link EngagementPlatformPluginOptions} instead.
66
+ * @see https://product-fabric.atlassian.net/browse/ED-27496
67
+ */
68
+ export type EngagementPlatformPluginConfig = EngagementPlatformPluginOptions;
63
69
  export type EpComponents = {
64
70
  EngagementSpotlight: ComponentType<{
65
71
  engagementId: string;
package/dist/types/index.d.ts CHANGED
@@ -1,2 +1,2 @@
1
1
  export { engagementPlatformPlugin } from './engagementPlatformPlugin';
2
- export type { EngagementPlatformPlugin, EngagementPlatformPluginConfig, EpComponents, EpHooks, CoordinationClient, EngagementPlatformPluginState, } from './engagementPlatformPluginType';
2
+ export type { EngagementPlatformPlugin, EngagementPlatformPluginConfig, EngagementPlatformPluginOptions, EpComponents, EpHooks, CoordinationClient, EngagementPlatformPluginState, } from './engagementPlatformPluginType';
package/dist/types/pm-plugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
2
- import type { EngagementPlatformPluginConfig } from '../../engagementPlatformPluginType';
2
+ import type { EngagementPlatformPluginOptions } from '../../engagementPlatformPluginType';
3
3
  import type { EngagementPlatformPmPluginState } from './types';
4
- export declare const engagementPlatformPmPlugin: (pluginConfig: EngagementPlatformPluginConfig) => SafePlugin<EngagementPlatformPmPluginState>;
4
+ export declare const engagementPlatformPmPlugin: (pluginConfig: EngagementPlatformPluginOptions) => SafePlugin<EngagementPlatformPmPluginState>;
package/dist/types-ts4.5/engagementPlatformPluginType.d.ts CHANGED
@@ -27,7 +27,7 @@ export type EngagementPlatformPlugin = NextEditorPlugin<'engagementPlatform', {
27
27
  */
28
28
  stopMessage: (messageId: string) => Promise<boolean>;
29
29
  };
30
- pluginConfiguration: EngagementPlatformPluginConfig;
30
+ pluginConfiguration: EngagementPlatformPluginOptions;
31
31
  dependencies: [
32
32
  OptionalPlugin<AnalyticsPlugin>
33
33
  ];
@@ -43,7 +43,7 @@ export interface CoordinationClient {
43
43
  start(messageId: string, variationId?: string): Promise<boolean>;
44
44
  stop(messageId: string): Promise<boolean>;
45
45
  }
46
- export type EngagementPlatformPluginConfig = {
46
+ export type EngagementPlatformPluginOptions = {
47
47
  epComponents: EpComponents;
48
48
  epHooks: EpHooks;
49
49
  /**
@@ -62,6 +62,12 @@ export type EngagementPlatformPluginConfig = {
62
62
  */
63
63
  coordinationClient: CoordinationClient;
64
64
  };
65
+ /**
66
+ * @private
67
+ * @deprecated Use {@link EngagementPlatformPluginOptions} instead.
68
+ * @see https://product-fabric.atlassian.net/browse/ED-27496
69
+ */
70
+ export type EngagementPlatformPluginConfig = EngagementPlatformPluginOptions;
65
71
  export type EpComponents = {
66
72
  EngagementSpotlight: ComponentType<{
67
73
  engagementId: string;
package/dist/types-ts4.5/index.d.ts CHANGED
@@ -1,2 +1,2 @@
1
1
  export { engagementPlatformPlugin } from './engagementPlatformPlugin';
2
- export type { EngagementPlatformPlugin, EngagementPlatformPluginConfig, EpComponents, EpHooks, CoordinationClient, EngagementPlatformPluginState, } from './engagementPlatformPluginType';
2
+ export type { EngagementPlatformPlugin, EngagementPlatformPluginConfig, EngagementPlatformPluginOptions, EpComponents, EpHooks, CoordinationClient, EngagementPlatformPluginState, } from './engagementPlatformPluginType';
package/dist/types-ts4.5/pm-plugins/engagementPlatformPmPlugin/engagementPlatformPmPlugin.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
2
- import type { EngagementPlatformPluginConfig } from '../../engagementPlatformPluginType';
2
+ import type { EngagementPlatformPluginOptions } from '../../engagementPlatformPluginType';
3
3
  import type { EngagementPlatformPmPluginState } from './types';
4
- export declare const engagementPlatformPmPlugin: (pluginConfig: EngagementPlatformPluginConfig) => SafePlugin<EngagementPlatformPmPluginState>;
4
+ export declare const engagementPlatformPmPlugin: (pluginConfig: EngagementPlatformPluginOptions) => SafePlugin<EngagementPlatformPmPluginState>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-engagement-platform",
3
- "version": "3.0.3",
3
+ "version": "3.1.0",
4
4
  "description": "Engagement platform plugin for @atlaskit/editor-core“",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -33,7 +33,7 @@
33
33
  ".": "./src/index.ts"
34
34
  },
35
35
  "dependencies": {
36
- "@atlaskit/editor-common": "^103.0.0",
36
+ "@atlaskit/editor-common": "^103.4.0",
37
37
  "@atlaskit/editor-plugin-analytics": "^2.2.0",
38
38
  "@atlaskit/editor-prosemirror": "7.0.0",
39
39
  "@babel/runtime": "^7.0.0"