@atlaskit/editor-plugin-analytics 5.3.0 → 6.1.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @atlaskit/editor-plugin-analytics
 
+## 6.1.0
+
+### Minor Changes
+
+- [`e3780960bb0ae`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e3780960bb0ae) - ##
+  What Update `EditorAnalyticsAPI` to allow for `fireAnalyticsEvent` to use a custom payload if an
+  explicit type parameter is used. This is mostly used by the analytics plugin
+
+  ```ts
+  // Example
+  api?.analytics.actions.fireAnalyticsEvent<CustomPayload, 'customEventType'>({ ... });
+  ```
+
+  ## Why
+
+  The current Payload structure is not extensible. There are times we don't want to update the base
+  analytics types (and increase bundle size) and scope them only to a specific package. This
+  provides an escape hatch but still enforces some level of type safety (currently there are some
+  examples of using `ts-expect-error` to side step this).
+
+  ## How to upgrade
+
+  In most scenarios this should not cause any breaking change but can be breaking if you are side
+  stepping type safety here with `ts-expect-error`.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 6.0.0
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 5.3.0
 
 ### Minor Changes

package/dist/cjs/analyticsPlugin.js

@@ -167,8 +167,14 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
           });
           return;
         }
+
+        // This cast is needed to satisfy TS when using custom payloads which is only allowed by
+        // the fireAnalyticsEvent function in EditorAnalyticsAPI for now.
+        // createAnalyticsEvent actually fires our standard AnalyticsEventPayload type which is less strict
+        // so this is safe.
+        var firedPayload = payload;
         (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent, options)({
-          payload: payload,
+          payload: firedPayload,
           channel: channel
         });
       }

package/dist/es2019/analyticsPlugin.js

@@ -129,7 +129,7 @@ const analyticsPlugin = ({
         });
         return true;
       },
-      fireAnalyticsEvent: (payload, channel = editorAnalyticsChannel, options) => {
+      fireAnalyticsEvent(payload, channel = editorAnalyticsChannel, options) {
         var _api$analytics$shared2, _api$analytics2;
         const {
           createAnalyticsEvent
@@ -144,8 +144,14 @@ const analyticsPlugin = ({
           });
           return;
         }
+
+        // This cast is needed to satisfy TS when using custom payloads which is only allowed by
+        // the fireAnalyticsEvent function in EditorAnalyticsAPI for now.
+        // createAnalyticsEvent actually fires our standard AnalyticsEventPayload type which is less strict
+        // so this is safe.
+        const firedPayload = payload;
         fireAnalyticsEvent(createAnalyticsEvent, options)({
-          payload,
+          payload: firedPayload,
           channel
         });
       }

package/dist/esm/analyticsPlugin.js

@@ -160,8 +160,14 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
           });
           return;
         }
+
+        // This cast is needed to satisfy TS when using custom payloads which is only allowed by
+        // the fireAnalyticsEvent function in EditorAnalyticsAPI for now.
+        // createAnalyticsEvent actually fires our standard AnalyticsEventPayload type which is less strict
+        // so this is safe.
+        var firedPayload = payload;
         _fireAnalyticsEvent(createAnalyticsEvent, options)({
-          payload: payload,
+          payload: firedPayload,
           channel: channel
         });
       }

package/dist/types/pm-plugins/analytics-api/editor-state-context.d.ts

@@ -1,8 +1,8 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import { SELECTION_POSITION, SELECTION_TYPE } from '@atlaskit/editor-common/analytics';
+import { SELECTION_POSITION, SELECTION_TYPE, type BaseEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function getSelectionType(selection: Selection): {
     position?: SELECTION_POSITION;
     type: SELECTION_TYPE;
 };
-export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload, tr?: Transaction): AnalyticsEventPayload;
+export declare function getStateContext<Payload extends BaseEventPayload = AnalyticsEventPayload>(selection: Selection, payload: Payload, tr?: Transaction): Payload;

package/dist/types-ts4.5/pm-plugins/analytics-api/editor-state-context.d.ts

@@ -1,8 +1,8 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import { SELECTION_POSITION, SELECTION_TYPE } from '@atlaskit/editor-common/analytics';
+import { SELECTION_POSITION, SELECTION_TYPE, type BaseEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function getSelectionType(selection: Selection): {
     position?: SELECTION_POSITION;
     type: SELECTION_TYPE;
 };
-export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload, tr?: Transaction): AnalyticsEventPayload;
+export declare function getStateContext<Payload extends BaseEventPayload = AnalyticsEventPayload>(selection: Selection, payload: Payload, tr?: Transaction): Payload;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-analytics",
-	"version": "5.3.0",
+	"version": "6.1.0",
 	"description": "Analytics plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -28,15 +28,15 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/adf-schema": "^51.2.0",
-		"@atlaskit/analytics-listeners": "^9.0.0",
+		"@atlaskit/analytics-listeners": "^9.1.0",
 		"@atlaskit/analytics-next": "^11.1.0",
-		"@atlaskit/editor-plugin-feature-flags": "^4.0.0",
+		"@atlaskit/editor-plugin-feature-flags": "^5.0.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^109.16.0",
+		"@atlaskit/editor-common": "^110.3.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {