@atlaskit/editor-plugin-analytics 0.1.5 → 0.1.7

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # @atlaskit/editor-plugin-analytics
 
+## 0.1.7
+
+### Patch Changes
+
+- [`8467bdcdf4f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/8467bdcdf4f) - Removing `dependencies` prop from PluginInjectionAPI and changing
+  signature of `NextEditorPlugin`.
+
+  Previously a `NextEditorPlugin` would be consumed as so:
+
+  ```ts
+  const plugin: NextEditorPlugin< ... > = (config, api) => {
+    // Can use api like so:
+    api.dependencies.core.actions.execute( ... )
+    return { ... }
+  }
+  ```
+
+  Now these have become named parameters like so and the `pluginInjectionAPI` is used
+  without the `dependencies` prop:
+
+  ```ts
+  const plugin: NextEditorPlugin< ... > = ({ config, api }) => {
+    // Can use api like so:
+    api.core.actions.execute( ... )
+    return { ... }
+  }
+  ```
+
+- Updated dependencies
+
+## 0.1.6
+
+### Patch Changes
+
+- [`24e27147cbd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/24e27147cbd) - Added atlaskit docs to all existing plugins.
+
 ## 0.1.5
 
 ### Patch Changes

package/dist/cjs/plugin.js

@@ -95,9 +95,12 @@ function createPlugin(options, featureFlags) {
     }
   });
 }
-var analyticsPlugin = function analyticsPlugin(options, api) {
-  var _api$dependencies$fea;
-  var featureFlags = (api === null || api === void 0 ? void 0 : (_api$dependencies$fea = api.dependencies.featureFlags) === null || _api$dependencies$fea === void 0 ? void 0 : _api$dependencies$fea.sharedState.currentState()) || {};
+var analyticsPlugin = function analyticsPlugin(_ref3) {
+  var _api$featureFlags;
+  var _ref3$config = _ref3.config,
+    options = _ref3$config === void 0 ? {} : _ref3$config,
+    api = _ref3.api;
+  var featureFlags = (api === null || api === void 0 ? void 0 : (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
   return {
     name: 'analytics',
     getSharedState: function getSharedState(editorState) {
@@ -108,8 +111,8 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
           attachAnalyticsEvent: null
         };
       }
-      var _ref3 = (_analyticsPluginKey$g = _pluginKey.analyticsPluginKey.getState(editorState)) !== null && _analyticsPluginKey$g !== void 0 ? _analyticsPluginKey$g : {},
-        createAnalyticsEvent = _ref3.createAnalyticsEvent;
+      var _ref4 = (_analyticsPluginKey$g = _pluginKey.analyticsPluginKey.getState(editorState)) !== null && _analyticsPluginKey$g !== void 0 ? _analyticsPluginKey$g : {},
+        createAnalyticsEvent = _ref4.createAnalyticsEvent;
       return {
         createAnalyticsEvent: createAnalyticsEvent,
         attachAnalyticsEvent: (0, _attachPayloadIntoTransaction.createAttachPayloadIntoTransaction)(editorState.selection)
@@ -119,10 +122,10 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
       attachAnalyticsEvent: function attachAnalyticsEvent(payload) {
         var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _analyticsListeners.FabricChannel.editor;
         return function (tr) {
-          var _api$dependencies$ana, _api$dependencies$ana2;
-          var _ref4 = (_api$dependencies$ana = api === null || api === void 0 ? void 0 : (_api$dependencies$ana2 = api.dependencies.analytics) === null || _api$dependencies$ana2 === void 0 ? void 0 : _api$dependencies$ana2.sharedState.currentState()) !== null && _api$dependencies$ana !== void 0 ? _api$dependencies$ana : {},
-            createAnalyticsEvent = _ref4.createAnalyticsEvent,
-            attachAnalyticsEvent = _ref4.attachAnalyticsEvent;
+          var _api$analytics$shared, _api$analytics;
+          var _ref5 = (_api$analytics$shared = api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.sharedState.currentState()) !== null && _api$analytics$shared !== void 0 ? _api$analytics$shared : {},
+            createAnalyticsEvent = _ref5.createAnalyticsEvent,
+            attachAnalyticsEvent = _ref5.attachAnalyticsEvent;
           if (!tr || !createAnalyticsEvent || !attachAnalyticsEvent) {
             return false;
           }
@@ -135,8 +138,8 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
         };
       }
     },
-    usePluginHook: function usePluginHook(_ref5) {
-      var editorView = _ref5.editorView;
+    usePluginHook: function usePluginHook(_ref6) {
+      var editorView = _ref6.editorView;
       var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
         createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
       (0, _react.useLayoutEffect)(function () {
@@ -156,10 +159,10 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
         }
       }];
     },
-    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref6) {
-      var originalTransaction = _ref6.originalTransaction,
-        transactions = _ref6.transactions,
-        newEditorState = _ref6.newEditorState;
+    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref7) {
+      var originalTransaction = _ref7.originalTransaction,
+        transactions = _ref7.transactions,
+        newEditorState = _ref7.newEditorState;
       var pluginState = _pluginKey.analyticsPluginKey.getState(newEditorState);
       if (!pluginState || !pluginState.createAnalyticsEvent) {
         return;
@@ -180,9 +183,9 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
       }
       var createAnalyticsEvent = pluginState.createAnalyticsEvent;
       var undoAnaltyicsEventTransformer = (0, _undoRedoInputSource.generateUndoRedoInputSoucePayload)(originalTransaction);
-      steps.forEach(function (_ref7) {
-        var payload = _ref7.payload,
-          channel = _ref7.channel;
+      steps.forEach(function (_ref8) {
+        var payload = _ref8.payload,
+          channel = _ref8.channel;
         var nextPayload = undoAnaltyicsEventTransformer(payload);
         (0, _analytics.fireAnalyticsEvent)(createAnalyticsEvent)({
           payload: nextPayload,
@@ -193,10 +196,10 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
   };
 };
 exports.analyticsPlugin = analyticsPlugin;
-function extendPayload(_ref8) {
-  var payload = _ref8.payload,
-    duration = _ref8.duration,
-    distortedDuration = _ref8.distortedDuration;
+function extendPayload(_ref9) {
+  var payload = _ref9.payload,
+    duration = _ref9.duration,
+    distortedDuration = _ref9.distortedDuration;
   return _objectSpread(_objectSpread({}, payload), {}, {
     attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
       duration: duration,

package/dist/es2019/plugin.js

@@ -73,9 +73,12 @@ function createPlugin(options, featureFlags) {
     }
   });
 }
-const analyticsPlugin = (options, api) => {
-  var _api$dependencies$fea;
-  const featureFlags = (api === null || api === void 0 ? void 0 : (_api$dependencies$fea = api.dependencies.featureFlags) === null || _api$dependencies$fea === void 0 ? void 0 : _api$dependencies$fea.sharedState.currentState()) || {};
+const analyticsPlugin = ({
+  config: options = {},
+  api
+}) => {
+  var _api$featureFlags;
+  const featureFlags = (api === null || api === void 0 ? void 0 : (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
   return {
     name: 'analytics',
     getSharedState: editorState => {
@@ -96,11 +99,11 @@ const analyticsPlugin = (options, api) => {
     },
     actions: {
       attachAnalyticsEvent: (payload, channel = FabricChannel.editor) => tr => {
-        var _api$dependencies$ana, _api$dependencies$ana2;
+        var _api$analytics$shared, _api$analytics;
         const {
           createAnalyticsEvent,
           attachAnalyticsEvent
-        } = (_api$dependencies$ana = api === null || api === void 0 ? void 0 : (_api$dependencies$ana2 = api.dependencies.analytics) === null || _api$dependencies$ana2 === void 0 ? void 0 : _api$dependencies$ana2.sharedState.currentState()) !== null && _api$dependencies$ana !== void 0 ? _api$dependencies$ana : {};
+        } = (_api$analytics$shared = api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.sharedState.currentState()) !== null && _api$analytics$shared !== void 0 ? _api$analytics$shared : {};
         if (!tr || !createAnalyticsEvent || !attachAnalyticsEvent) {
           return false;
         }

package/dist/esm/plugin.js

@@ -87,9 +87,12 @@ function createPlugin(options, featureFlags) {
     }
   });
 }
-var analyticsPlugin = function analyticsPlugin(options, api) {
-  var _api$dependencies$fea;
-  var featureFlags = (api === null || api === void 0 ? void 0 : (_api$dependencies$fea = api.dependencies.featureFlags) === null || _api$dependencies$fea === void 0 ? void 0 : _api$dependencies$fea.sharedState.currentState()) || {};
+var analyticsPlugin = function analyticsPlugin(_ref3) {
+  var _api$featureFlags;
+  var _ref3$config = _ref3.config,
+    options = _ref3$config === void 0 ? {} : _ref3$config,
+    api = _ref3.api;
+  var featureFlags = (api === null || api === void 0 ? void 0 : (_api$featureFlags = api.featureFlags) === null || _api$featureFlags === void 0 ? void 0 : _api$featureFlags.sharedState.currentState()) || {};
   return {
     name: 'analytics',
     getSharedState: function getSharedState(editorState) {
@@ -100,8 +103,8 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
           attachAnalyticsEvent: null
         };
       }
-      var _ref3 = (_analyticsPluginKey$g = analyticsPluginKey.getState(editorState)) !== null && _analyticsPluginKey$g !== void 0 ? _analyticsPluginKey$g : {},
-        createAnalyticsEvent = _ref3.createAnalyticsEvent;
+      var _ref4 = (_analyticsPluginKey$g = analyticsPluginKey.getState(editorState)) !== null && _analyticsPluginKey$g !== void 0 ? _analyticsPluginKey$g : {},
+        createAnalyticsEvent = _ref4.createAnalyticsEvent;
       return {
         createAnalyticsEvent: createAnalyticsEvent,
         attachAnalyticsEvent: createAttachPayloadIntoTransaction(editorState.selection)
@@ -111,10 +114,10 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
       attachAnalyticsEvent: function attachAnalyticsEvent(payload) {
         var channel = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : FabricChannel.editor;
         return function (tr) {
-          var _api$dependencies$ana, _api$dependencies$ana2;
-          var _ref4 = (_api$dependencies$ana = api === null || api === void 0 ? void 0 : (_api$dependencies$ana2 = api.dependencies.analytics) === null || _api$dependencies$ana2 === void 0 ? void 0 : _api$dependencies$ana2.sharedState.currentState()) !== null && _api$dependencies$ana !== void 0 ? _api$dependencies$ana : {},
-            createAnalyticsEvent = _ref4.createAnalyticsEvent,
-            attachAnalyticsEvent = _ref4.attachAnalyticsEvent;
+          var _api$analytics$shared, _api$analytics;
+          var _ref5 = (_api$analytics$shared = api === null || api === void 0 ? void 0 : (_api$analytics = api.analytics) === null || _api$analytics === void 0 ? void 0 : _api$analytics.sharedState.currentState()) !== null && _api$analytics$shared !== void 0 ? _api$analytics$shared : {},
+            createAnalyticsEvent = _ref5.createAnalyticsEvent,
+            attachAnalyticsEvent = _ref5.attachAnalyticsEvent;
           if (!tr || !createAnalyticsEvent || !attachAnalyticsEvent) {
             return false;
           }
@@ -127,8 +130,8 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
         };
       }
     },
-    usePluginHook: function usePluginHook(_ref5) {
-      var editorView = _ref5.editorView;
+    usePluginHook: function usePluginHook(_ref6) {
+      var editorView = _ref6.editorView;
       var _useAnalyticsEvents = useAnalyticsEvents(),
         createAnalyticsEvent = _useAnalyticsEvents.createAnalyticsEvent;
       useLayoutEffect(function () {
@@ -148,10 +151,10 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
         }
       }];
     },
-    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref6) {
-      var originalTransaction = _ref6.originalTransaction,
-        transactions = _ref6.transactions,
-        newEditorState = _ref6.newEditorState;
+    onEditorViewStateUpdated: function onEditorViewStateUpdated(_ref7) {
+      var originalTransaction = _ref7.originalTransaction,
+        transactions = _ref7.transactions,
+        newEditorState = _ref7.newEditorState;
       var pluginState = analyticsPluginKey.getState(newEditorState);
       if (!pluginState || !pluginState.createAnalyticsEvent) {
         return;
@@ -172,9 +175,9 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
       }
       var createAnalyticsEvent = pluginState.createAnalyticsEvent;
       var undoAnaltyicsEventTransformer = generateUndoRedoInputSoucePayload(originalTransaction);
-      steps.forEach(function (_ref7) {
-        var payload = _ref7.payload,
-          channel = _ref7.channel;
+      steps.forEach(function (_ref8) {
+        var payload = _ref8.payload,
+          channel = _ref8.channel;
         var nextPayload = undoAnaltyicsEventTransformer(payload);
         fireAnalyticsEvent(createAnalyticsEvent)({
           payload: nextPayload,
@@ -184,10 +187,10 @@ var analyticsPlugin = function analyticsPlugin(options, api) {
     }
   };
 };
-export function extendPayload(_ref8) {
-  var payload = _ref8.payload,
-    duration = _ref8.duration,
-    distortedDuration = _ref8.distortedDuration;
+export function extendPayload(_ref9) {
+  var payload = _ref9.payload,
+    duration = _ref9.duration,
+    distortedDuration = _ref9.distortedDuration;
   return _objectSpread(_objectSpread({}, payload), {}, {
     attributes: _objectSpread(_objectSpread({}, payload.attributes), {}, {
       duration: duration,

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
 export { analyticsPlugin } from './plugin';
-export type { AnalyticsPluginOptions } from './plugin';
+export type { AnalyticsPlugin, AnalyticsPluginOptions } from './plugin';
 export type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';

package/dist/types/plugin.d.ts

@@ -1,21 +1,22 @@
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { NextEditorPlugin, PerformanceTracking } from '@atlaskit/editor-common/types';
-import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
-import { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
 export interface AnalyticsPluginOptions {
     createAnalyticsEvent?: CreateUIAnalyticsEvent;
     performanceTracking?: PerformanceTracking;
 }
-declare const analyticsPlugin: NextEditorPlugin<'analytics', {
+export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
     pluginConfiguration: AnalyticsPluginOptions;
     sharedState: {
         createAnalyticsEvent: CreateUIAnalyticsEvent | null;
         attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
     };
-    dependencies: [typeof featureFlagsPlugin];
+    dependencies: [FeatureFlagsPlugin];
     actions: EditorAnalyticsAPI;
 }>;
+declare const analyticsPlugin: AnalyticsPlugin;
 export declare function extendPayload({ payload, duration, distortedDuration, }: {
     payload: AnalyticsEventPayload;
     duration: number;

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

@@ -1,3 +1,3 @@
 export { analyticsPlugin } from './plugin';
-export type { AnalyticsPluginOptions } from './plugin';
+export type { AnalyticsPlugin, AnalyticsPluginOptions } from './plugin';
 export type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';

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

@@ -1,23 +1,24 @@
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { AnalyticsEventPayload, EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
 import type { NextEditorPlugin, PerformanceTracking } from '@atlaskit/editor-common/types';
-import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
-import { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
+import type { CreateAttachPayloadIntoTransaction } from './analytics-api/attach-payload-into-transaction';
 export interface AnalyticsPluginOptions {
     createAnalyticsEvent?: CreateUIAnalyticsEvent;
     performanceTracking?: PerformanceTracking;
 }
-declare const analyticsPlugin: NextEditorPlugin<'analytics', {
+export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
     pluginConfiguration: AnalyticsPluginOptions;
     sharedState: {
         createAnalyticsEvent: CreateUIAnalyticsEvent | null;
         attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
     };
     dependencies: [
-        typeof featureFlagsPlugin
+        FeatureFlagsPlugin
     ];
     actions: EditorAnalyticsAPI;
 }>;
+declare const analyticsPlugin: AnalyticsPlugin;
 export declare function extendPayload({ payload, duration, distortedDuration, }: {
     payload: AnalyticsEventPayload;
     duration: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-analytics",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Analytics plugin for @atlaskit/editor-core",
   "author": "Atlassian Pty Ltd",
   "license": "Apache-2.0",
@@ -34,7 +34,7 @@
     "@atlaskit/adf-schema": "28.1.2",
     "@atlaskit/analytics-listeners": "^8.6.0",
     "@atlaskit/analytics-next": "^9.0.0",
-    "@atlaskit/editor-common": "^74.51.0",
+    "@atlaskit/editor-common": "^74.53.0",
     "@atlaskit/editor-plugin-feature-flags": "^0.1.0",
     "@atlaskit/editor-prosemirror": "1.1.0",
     "@atlaskit/editor-tables": "^2.2.0",
@@ -44,7 +44,6 @@
     "react": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/editor-test-helpers": "^18.11.0",
     "@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
     "@testing-library/react": "^12.1.5",
     "react-dom": "^16.8.0",

package/report.api.md

@@ -16,15 +16,15 @@
 
 ```ts
 import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { PerformanceTracking } from '@atlaskit/editor-common/types';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 
 // @public (undocumented)
-export const analyticsPlugin: NextEditorPlugin<
+export type AnalyticsPlugin = NextEditorPlugin<
   'analytics',
   {
     pluginConfiguration: AnalyticsPluginOptions;
@@ -32,11 +32,14 @@ export const analyticsPlugin: NextEditorPlugin<
       createAnalyticsEvent: CreateUIAnalyticsEvent | null;
       attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
     };
-    dependencies: [typeof featureFlagsPlugin];
+    dependencies: [FeatureFlagsPlugin];
     actions: EditorAnalyticsAPI;
   }
 >;
 
+// @public (undocumented)
+export const analyticsPlugin: AnalyticsPlugin;
+
 // @public (undocumented)
 export interface AnalyticsPluginOptions {
   // (undocumented)

package/tmp/api-report-tmp.d.ts

@@ -5,24 +5,27 @@
 ```ts
 
 import { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
-import { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import type featureFlagsPlugin from '@atlaskit/editor-plugin-feature-flags';
+import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
+import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
+import type { FeatureFlagsPlugin } from '@atlaskit/editor-plugin-feature-flags';
 import type { NextEditorPlugin } from '@atlaskit/editor-common/types';
 import type { PerformanceTracking } from '@atlaskit/editor-common/types';
 import type { Transaction } from '@atlaskit/editor-prosemirror/state';
 
 // @public (undocumented)
-export const analyticsPlugin: NextEditorPlugin<'analytics', {
+export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
     pluginConfiguration: AnalyticsPluginOptions;
     sharedState: {
         createAnalyticsEvent: CreateUIAnalyticsEvent | null;
         attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
     };
-    dependencies: [typeof featureFlagsPlugin];
+    dependencies: [FeatureFlagsPlugin];
     actions: EditorAnalyticsAPI;
 }>;
 
+// @public (undocumented)
+export const analyticsPlugin: AnalyticsPlugin;
+
 // @public (undocumented)
 export interface AnalyticsPluginOptions {
     // (undocumented)