@atlaskit/editor-plugin-analytics 0.1.5 → 0.1.6

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 (8) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/types/index.d.ts +1 -1
  3. package/dist/types/plugin.d.ts +7 -6
  4. package/dist/types-ts4.5/index.d.ts +1 -1
  5. package/dist/types-ts4.5/plugin.d.ts +7 -6
  6. package/package.json +2 -3
  7. package/report.api.md +8 -5
  8. package/tmp/api-report-tmp.d.ts +0 -43
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @atlaskit/editor-plugin-analytics
2
2
 
3
+ ## 0.1.6
4
+
5
+ ### Patch Changes
6
+
7
+ - [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added atlaskit docs to all existing plugins.
8
+
3
9
  ## 0.1.5
4
10
 
5
11
  ### Patch Changes
package/dist/types/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  export { analyticsPlugin } from './plugin';
2
- export type { AnalyticsPluginOptions } from './plugin';
2
+ export type { AnalyticsPlugin, AnalyticsPluginOptions } from './plugin';
3
3
  export type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
package/dist/types/plugin.d.ts CHANGED
@@ -1,21 +1,22 @@
1
- import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
2
- import { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
1
+ import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
2
+ import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
3
3
  import type { NextEditorPlugin, PerformanceTracking } from '@atlaskit/editor-common/types';
4
- import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
5
- import { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
4
+ import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
5
+ import type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
6
6
  export interface AnalyticsPluginOptions {
7
7
  createAnalyticsEvent?: CreateUIAnalyticsEvent;
8
8
  performanceTracking?: PerformanceTracking;
9
9
  }
10
- declare const analyticsPlugin: NextEditorPlugin<'analytics', {
10
+ export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
11
11
  pluginConfiguration: AnalyticsPluginOptions;
12
12
  sharedState: {
13
13
  createAnalyticsEvent: CreateUIAnalyticsEvent | null;
14
14
  attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
15
15
  };
16
- dependencies: [typeof featureFlagsPlugin];
16
+ dependencies: [FeatureFlagsPlugin];
17
17
  actions: EditorAnalyticsAPI;
18
18
  }>;
19
+ declare const analyticsPlugin: AnalyticsPlugin;
19
20
  export declare function extendPayload({ payload, duration, distortedDuration, }: {
20
21
  payload: AnalyticsEventPayload;
21
22
  duration: number;
package/dist/types-ts4.5/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  export { analyticsPlugin } from './plugin';
2
- export type { AnalyticsPluginOptions } from './plugin';
2
+ export type { AnalyticsPlugin, AnalyticsPluginOptions } from './plugin';
3
3
  export type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
package/dist/types-ts4.5/plugin.d.ts CHANGED
@@ -1,23 +1,24 @@
1
- import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
2
- import { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
1
+ import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
2
+ import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
3
3
  import type { NextEditorPlugin, PerformanceTracking } from '@atlaskit/editor-common/types';
4
- import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
5
- import { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
4
+ import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
5
+ import type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
6
6
  export interface AnalyticsPluginOptions {
7
7
  createAnalyticsEvent?: CreateUIAnalyticsEvent;
8
8
  performanceTracking?: PerformanceTracking;
9
9
  }
10
- declare const analyticsPlugin: NextEditorPlugin<'analytics', {
10
+ export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
11
11
  pluginConfiguration: AnalyticsPluginOptions;
12
12
  sharedState: {
13
13
  createAnalyticsEvent: CreateUIAnalyticsEvent | null;
14
14
  attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
15
15
  };
16
16
  dependencies: [
17
- typeof featureFlagsPlugin
17
+ FeatureFlagsPlugin
18
18
  ];
19
19
  actions: EditorAnalyticsAPI;
20
20
  }>;
21
+ declare const analyticsPlugin: AnalyticsPlugin;
21
22
  export declare function extendPayload({ payload, duration, distortedDuration, }: {
22
23
  payload: AnalyticsEventPayload;
23
24
  duration: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/editor-plugin-analytics",
3
- "version": "0.1.5",
3
+ "version": "0.1.6",
4
4
  "description": "Analytics plugin for @atlaskit/editor-core",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -34,7 +34,7 @@
34
34
  "@atlaskit/adf-schema": "28.1.2",
35
35
  "@atlaskit/analytics-listeners": "^8.6.0",
36
36
  "@atlaskit/analytics-next": "^9.0.0",
37
- "@atlaskit/editor-common": "^74.51.0",
37
+ "@atlaskit/editor-common": "^74.52.0",
38
38
  "@atlaskit/editor-plugin-feature-flags": "^0.1.0",
39
39
  "@atlaskit/editor-prosemirror": "1.1.0",
40
40
  "@atlaskit/editor-tables": "^2.2.0",
@@ -44,7 +44,6 @@
44
44
  "react": "^16.8.0"
45
45
  },
46
46
  "devDependencies": {
47
- "@atlaskit/editor-test-helpers": "^18.11.0",
48
47
  "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
49
48
  "@testing-library/react": "^12.1.5",
50
49
  "react-dom": "^16.8.0",
package/report.api.md CHANGED
@@ -16,15 +16,15 @@
16
16
 
17
17
  ```ts
18
18
  import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
19
- import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
20
- import { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
21
- import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
19
+ import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
20
+ import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
21
+ import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
22
22
  import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
23
23
  import type { PerformanceTracking } from '@atlaskit/editor-common/types';
24
24
  import type { Transaction } from '@atlaskit/editor-prosemirror/state';
25
25
 
26
26
  // @public (undocumented)
27
- export const analyticsPlugin: NextEditorPlugin<
27
+ export type AnalyticsPlugin = NextEditorPlugin<
28
28
  'analytics',
29
29
  {
30
30
  pluginConfiguration: AnalyticsPluginOptions;
@@ -32,11 +32,14 @@ export const analyticsPlugin: NextEditorPlugin<
32
32
  createAnalyticsEvent: CreateUIAnalyticsEvent | null;
33
33
  attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
34
34
  };
35
- dependencies: [typeof featureFlagsPlugin];
35
+ dependencies: [FeatureFlagsPlugin];
36
36
  actions: EditorAnalyticsAPI;
37
37
  }
38
38
  >;
39
39
 
40
+ // @public (undocumented)
41
+ export const analyticsPlugin: AnalyticsPlugin;
42
+
40
43
  // @public (undocumented)
41
44
  export interface AnalyticsPluginOptions {
42
45
  // (undocumented)
package/tmp/api-report-tmp.d.ts DELETED
@@ -1,43 +0,0 @@
1
- ## API Report File for "@atlaskit/editor-plugin-analytics"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
8
- import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
9
- import { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
10
- import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
11
- import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
12
- import type { PerformanceTracking } from '@atlaskit/editor-common/types';
13
- import type { Transaction } from '@atlaskit/editor-prosemirror/state';
14
-
15
- // @public (undocumented)
16
- export const analyticsPlugin: NextEditorPlugin<'analytics', {
17
- pluginConfiguration: AnalyticsPluginOptions;
18
- sharedState: {
19
- createAnalyticsEvent: CreateUIAnalyticsEvent | null;
20
- attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
21
- };
22
- dependencies: [typeof featureFlagsPlugin];
23
- actions: EditorAnalyticsAPI;
24
- }>;
25
-
26
- // @public (undocumented)
27
- export interface AnalyticsPluginOptions {
28
- // (undocumented)
29
- createAnalyticsEvent?: CreateUIAnalyticsEvent;
30
- // (undocumented)
31
- performanceTracking?: PerformanceTracking;
32
- }
33
-
34
- // @public (undocumented)
35
- export type CreateAttachPayloadIntoTransaction = (props: {
36
- payload: AnalyticsEventPayload;
37
- tr: Transaction;
38
- channel: string;
39
- }) => void;
40
-
41
- // (No @packageDocumentation comment for this package)
42
-
43
- ```