@atlaskit/editor-plugin-analytics 0.3.6 → 0.4.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-analytics
 
+## 0.4.1
+
+### Patch Changes
+
+- [#58246](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/58246) [`a381b2599716`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/a381b2599716) - ED-21371 Update adf-schema to 35.1.0
+
+## 0.4.0
+
+### Minor Changes
+
+- [#59421](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/59421) [`3747754f8ab0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/3747754f8ab0) - NO-ISSUE Added the capability to directly trigger an analytics event as an action to the editor analytics plugin
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 0.3.6
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -143,10 +143,21 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
           });
           return true;
         };
+      },
+      fireAnalyticsEvent: function fireAnalyticsEvent(payload) {
+        var _api$analytics$shared2, _api$analytics2;
+        var _ref6 = (_api$analytics$shared2 = api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.sharedState.currentState()) !== null && _api$analytics$shared2 !== void 0 ? _api$analytics$shared2 : {},
+          createAnalyticsEvent = _ref6.createAnalyticsEvent;
+        if (!createAnalyticsEvent) {
+          return;
+        }
+        (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent)({
+          payload: payload
+        });
       }
     },
-    usePluginHook: function usePluginHook(_ref6) {
-      var editorView = _ref6.editorView;
+    usePluginHook: function usePluginHook(_ref7) {
+      var editorView = _ref7.editorView;
       var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
         createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
       (0, _react.useLayoutEffect)(function () {
@@ -166,10 +177,10 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
         }
       }];
     },
-    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref7) {
-      var originalTransaction = _ref7.originalTransaction,
-        transactions = _ref7.transactions,
-        newEditorState = _ref7.newEditorState;
+    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref8) {
+      var originalTransaction = _ref8.originalTransaction,
+        transactions = _ref8.transactions,
+        newEditorState = _ref8.newEditorState;
       var pluginState = _pluginKey.analyticsPluginKey.getState(newEditorState);
       if (!pluginState || !pluginState.createAnalyticsEvent) {
         return;
@@ -190,9 +201,9 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
       }
       var createAnalyticsEvent = pluginState.createAnalyticsEvent;
       var undoAnaltyicsEventTransformer = (0, _undoRedoInputSource.generateUndoRedoInputSoucePayload)(originalTransaction);
-      steps.forEach(function (_ref8) {
-        var payload = _ref8.payload,
-          channel = _ref8.channel;
+      steps.forEach(function (_ref9) {
+        var payload = _ref9.payload,
+          channel = _ref9.channel;
         var nextPayload = undoAnaltyicsEventTransformer(payload);
         (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent)({
           payload: nextPayload,
@@ -202,10 +213,10 @@ var analyticsPlugin = exports.analyticsPlugin = function analyticsPlugin(_ref3)
     }
   };
 };
-function extendPayload(_ref9) {
-  var payload = _ref9.payload,
-    duration = _ref9.duration,
-    distortedDuration = _ref9.distortedDuration;
+function extendPayload(_ref10) {
+  var payload = _ref10.payload,
+    duration = _ref10.duration,
+    distortedDuration = _ref10.distortedDuration;
   return _objectSpread(_objectSpread({}, payload), {}, {
     attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
       duration: duration,

package/dist/es2019/plugin.js

@@ -120,6 +120,18 @@ const analyticsPlugin = ({
           channel
         });
         return true;
+      },
+      fireAnalyticsEvent: payload => {
+        var _api$analytics$shared2, _api$analytics2;
+        const {
+          createAnalyticsEvent
+        } = (_api$analytics$shared2 = api === null || api === void 0 ? void 0 : (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.sharedState.currentState()) !== null && _api$analytics$shared2 !== void 0 ? _api$analytics$shared2 : {};
+        if (!createAnalyticsEvent) {
+          return;
+        }
+        fireAnalyticsEvent(createAnalyticsEvent)({
+          payload
+        });
       }
     },
     usePluginHook({

package/dist/esm/plugin.js

@@ -9,7 +9,7 @@ import { useLayoutEffect } from 'react';
 import { AnalyticsStep } from '@atlaskit/adf-schema/steps';
 import { FabricChannel } from '@atlaskit/analytics-listeners';
 import { useAnalyticsEvents } from '@atlaskit/analytics-next';
-import { ACTION, EVENT_TYPE, fireAnalyticsEvent, getAnalyticsEventsFromTransaction } from '@atlaskit/editor-common/analytics';
+import { ACTION, EVENT_TYPE, fireAnalyticsEvent as _fireAnalyticsEvent, getAnalyticsEventsFromTransaction } from '@atlaskit/editor-common/analytics';
 import { SafePlugin } from '@atlaskit/editor-common/safe-plugin';
 import { isPerformanceAPIAvailable, measureRender } from '@atlaskit/editor-common/utils';
 import { createAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
@@ -25,7 +25,7 @@ function createPlugin(options, featureFlags) {
     state: {
       init: function init() {
         return _objectSpread(_objectSpread({}, options), {}, {
-          fireAnalytics: fireAnalyticsEvent(options.createAnalyticsEvent)
+          fireAnalytics: _fireAnalyticsEvent(options.createAnalyticsEvent)
         });
       },
       apply: function apply(tr, pluginState, _, state) {
@@ -61,7 +61,7 @@ function createPlugin(options, featureFlags) {
                   measureName, function (_ref2) {
                     var duration = _ref2.duration,
                       distortedDuration = _ref2.distortedDuration;
-                    fireAnalyticsEvent(pluginState.createAnalyticsEvent)({
+                    _fireAnalyticsEvent(pluginState.createAnalyticsEvent)({
                       payload: extendPayload({
                         payload: payload,
                         duration: duration,
@@ -135,10 +135,21 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
           });
           return true;
         };
+      },
+      fireAnalyticsEvent: function fireAnalyticsEvent(payload) {
+        var _api$analytics$shared2, _api$analytics2;
+        var _ref6 = (_api$analytics$shared2 = api === null || api === void 0 || (_api$analytics2 = api.analytics) === null || _api$analytics2 === void 0 ? void 0 : _api$analytics2.sharedState.currentState()) !== null && _api$analytics$shared2 !== void 0 ? _api$analytics$shared2 : {},
+          createAnalyticsEvent = _ref6.createAnalyticsEvent;
+        if (!createAnalyticsEvent) {
+          return;
+        }
+        _fireAnalyticsEvent(createAnalyticsEvent)({
+          payload: payload
+        });
       }
     },
-    usePluginHook: function usePluginHook(_ref6) {
-      var editorView = _ref6.editorView;
+    usePluginHook: function usePluginHook(_ref7) {
+      var editorView = _ref7.editorView;
       var _useAnalyticsEvents = useAnalyticsEvents(),
         createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
       useLayoutEffect(function () {
@@ -158,10 +169,10 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
         }
       }];
     },
-    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref7) {
-      var originalTransaction = _ref7.originalTransaction,
-        transactions = _ref7.transactions,
-        newEditorState = _ref7.newEditorState;
+    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref8) {
+      var originalTransaction = _ref8.originalTransaction,
+        transactions = _ref8.transactions,
+        newEditorState = _ref8.newEditorState;
       var pluginState = analyticsPluginKey.getState(newEditorState);
       if (!pluginState || !pluginState.createAnalyticsEvent) {
         return;
@@ -182,11 +193,11 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
       }
       var createAnalyticsEvent = pluginState.createAnalyticsEvent;
       var undoAnaltyicsEventTransformer = generateUndoRedoInputSoucePayload(originalTransaction);
-      steps.forEach(function (_ref8) {
-        var payload = _ref8.payload,
-          channel = _ref8.channel;
+      steps.forEach(function (_ref9) {
+        var payload = _ref9.payload,
+          channel = _ref9.channel;
         var nextPayload = undoAnaltyicsEventTransformer(payload);
-        fireAnalyticsEvent(createAnalyticsEvent)({
+        _fireAnalyticsEvent(createAnalyticsEvent)({
           payload: nextPayload,
           channel: channel
         });
@@ -194,10 +205,10 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
     }
   };
 };
-export function extendPayload(_ref9) {
-  var payload = _ref9.payload,
-    duration = _ref9.duration,
-    distortedDuration = _ref9.distortedDuration;
+export function extendPayload(_ref10) {
+  var payload = _ref10.payload,
+    duration = _ref10.duration,
+    distortedDuration = _ref10.distortedDuration;
   return _objectSpread(_objectSpread({}, payload), {}, {
     attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
       duration: duration,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-analytics",
-  "version": "0.3.6",
+  "version": "0.4.1",
   "description": "Analytics plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -31,10 +31,10 @@
     ".": "./src/index.ts"
   },
   "dependencies": {
-    "@atlaskit/adf-schema": "^35.0.0",
+    "@atlaskit/adf-schema": "^35.1.0",
     "@atlaskit/analytics-listeners": "^8.6.0",
     "@atlaskit/analytics-next": "^9.0.0",
-    "@atlaskit/editor-common": "^76.25.0",
+    "@atlaskit/editor-common": "^76.26.0",
     "@atlaskit/editor-plugin-feature-flags": "^1.0.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-tables": "^2.2.0",