@atlaskit/editor-plugin-analytics 3.0.3 → 3.0.5

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-plugin-analytics
 
+## 3.0.5
+
+### Patch Changes
+
+- [`265c1bf0cefa4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/265c1bf0cefa4) -
+  Sorted type and interface props to improve Atlaskit docs
+
+## 3.0.4
+
+### Patch Changes
+
+- [`57b19274b9fdd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/57b19274b9fdd) -
+  EDITOR-1373 Bump adf-schema version
+- Updated dependencies
+
 ## 3.0.3
 
 ### Patch Changes

package/dist/cjs/analyticsPlugin.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.analyticsPlugin = void 0;
-exports.extendPayload = extendPayload;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("react");

package/dist/cjs/pm-plugins/analytics-api/attach-payload-into-transaction.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.createAttachPayloadIntoTransaction = exports.attachPayloadIntoTransaction = void 0;
+exports.createAttachPayloadIntoTransaction = void 0;
 var _steps = require("@atlaskit/adf-schema/steps");
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _editorStateContext = require("./editor-state-context");
@@ -27,7 +27,7 @@ var createAttachPayloadIntoTransaction = exports.createAttachPayloadIntoTransact
 //  to create new util attachPayloadIntoTransaction in above file.
 // If you make a change here, please review attachPayloadIntoTransaction in above
 //  file and update it as well if needed.
-var attachPayloadIntoTransaction = exports.attachPayloadIntoTransaction = function attachPayloadIntoTransaction(_ref2) {
+var attachPayloadIntoTransaction = function attachPayloadIntoTransaction(_ref2) {
   var payload = _ref2.payload,
     selection = _ref2.selection,
     tr = _ref2.tr,

package/dist/cjs/pm-plugins/analytics-api/editor-state-context.js

@@ -3,7 +3,6 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.findInsertedLocation = findInsertedLocation;
 exports.getSelectionType = getSelectionType;
 exports.getStateContext = getStateContext;
 var _analytics = require("@atlaskit/editor-common/analytics");

package/dist/es2019/analyticsPlugin.js

@@ -229,7 +229,7 @@ const analyticsPlugin = ({
     }
   };
 };
-export function extendPayload({
+function extendPayload({
   payload,
   duration,
   distortedDuration

package/dist/es2019/pm-plugins/analytics-api/attach-payload-into-transaction.js

@@ -18,7 +18,7 @@ export const createAttachPayloadIntoTransaction = selection => ({
 //  to create new util attachPayloadIntoTransaction in above file.
 // If you make a change here, please review attachPayloadIntoTransaction in above
 //  file and update it as well if needed.
-export const attachPayloadIntoTransaction = ({
+const attachPayloadIntoTransaction = ({
   payload,
   selection,
   tr,

package/dist/es2019/pm-plugins/analytics-api/editor-state-context.js

@@ -37,7 +37,7 @@ export function getSelectionType(selection) {
     position
   };
 }
-export function findInsertedLocation(oldSelection, newSelection) {
+function findInsertedLocation(oldSelection, newSelection) {
   const {
     schema
   } = newSelection.$from.doc.type;

package/dist/esm/analyticsPlugin.js

@@ -242,7 +242,7 @@ var analyticsPlugin = function analyticsPlugin(_ref3) {
     }
   };
 };
-export function extendPayload(_ref1) {
+function extendPayload(_ref1) {
   var payload = _ref1.payload,
     duration = _ref1.duration,
     distortedDuration = _ref1.distortedDuration;

package/dist/esm/pm-plugins/analytics-api/attach-payload-into-transaction.js

@@ -21,7 +21,7 @@ export var createAttachPayloadIntoTransaction = function createAttachPayloadInto
 //  to create new util attachPayloadIntoTransaction in above file.
 // If you make a change here, please review attachPayloadIntoTransaction in above
 //  file and update it as well if needed.
-export var attachPayloadIntoTransaction = function attachPayloadIntoTransaction(_ref2) {
+var attachPayloadIntoTransaction = function attachPayloadIntoTransaction(_ref2) {
   var payload = _ref2.payload,
     selection = _ref2.selection,
     tr = _ref2.tr,

package/dist/esm/pm-plugins/analytics-api/editor-state-context.js

@@ -35,7 +35,7 @@ export function getSelectionType(selection) {
     position: position
   };
 }
-export function findInsertedLocation(oldSelection, newSelection) {
+function findInsertedLocation(oldSelection, newSelection) {
   var schema = newSelection.$from.doc.type.schema;
   var _schema$nodes = schema.nodes,
     paragraph = _schema$nodes.paragraph,

package/dist/types/analyticsPlugin.d.ts

@@ -1,13 +1,7 @@
-import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { AnalyticsPlugin } from './analyticsPluginType';
 /**
  * Analytics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
  */
 declare const analyticsPlugin: AnalyticsPlugin;
-export declare function extendPayload({ payload, duration, distortedDuration, }: {
-    payload: AnalyticsEventPayload;
-    duration: number;
-    distortedDuration: boolean;
-}): AnalyticsEventPayload;
 export { analyticsPlugin };

package/dist/types/analyticsPluginType.d.ts

@@ -8,20 +8,20 @@ export interface AnalyticsPluginOptions {
     performanceTracking?: PerformanceTracking;
 }
 export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
+    actions: EditorAnalyticsAPI;
+    dependencies: [OptionalPlugin<FeatureFlagsPlugin>];
     pluginConfiguration: AnalyticsPluginOptions;
     sharedState: {
         /**
          * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
          * instead, as it will properly queue all events.
          */
-        createAnalyticsEvent: CreateUIAnalyticsEvent | null;
+        attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
         /**
          * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
          * instead, as it will properly queue all events.
          */
-        attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
+        createAnalyticsEvent: CreateUIAnalyticsEvent | null;
         performanceTracking: PerformanceTracking | undefined;
     };
-    dependencies: [OptionalPlugin<FeatureFlagsPlugin>];
-    actions: EditorAnalyticsAPI;
 }>;

package/dist/types/pm-plugins/analytics-api/attach-payload-into-transaction.d.ts

@@ -1,16 +1,8 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
-type AttachPayloadIntoTransaction = (props: {
-    payload: AnalyticsEventPayload;
-    selection: Selection;
-    tr: Transaction;
-    channel: string;
-}) => void;
 export type CreateAttachPayloadIntoTransaction = (props: {
+    channel: string;
     payload: AnalyticsEventPayload;
     tr: Transaction;
-    channel: string;
 }) => void;
 export declare const createAttachPayloadIntoTransaction: (selection: Selection) => CreateAttachPayloadIntoTransaction;
-export declare const attachPayloadIntoTransaction: AttachPayloadIntoTransaction;
-export {};

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

@@ -2,8 +2,7 @@ import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import { SELECTION_POSITION, SELECTION_TYPE } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function getSelectionType(selection: Selection): {
-    type: SELECTION_TYPE;
     position?: SELECTION_POSITION;
+    type: SELECTION_TYPE;
 };
-export declare function findInsertedLocation(oldSelection: Selection, newSelection: Selection): string;
 export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload, tr?: Transaction): AnalyticsEventPayload;

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

@@ -1,13 +1,7 @@
-import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { AnalyticsPlugin } from './analyticsPluginType';
 /**
  * Analytics plugin to be added to an `EditorPresetBuilder` and used with `ComposableEditor`
  * from `@atlaskit/editor-core`.
  */
 declare const analyticsPlugin: AnalyticsPlugin;
-export declare function extendPayload({ payload, duration, distortedDuration, }: {
-    payload: AnalyticsEventPayload;
-    duration: number;
-    distortedDuration: boolean;
-}): AnalyticsEventPayload;
 export { analyticsPlugin };

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

@@ -8,22 +8,22 @@ export interface AnalyticsPluginOptions {
     performanceTracking?: PerformanceTracking;
 }
 export type AnalyticsPlugin = NextEditorPlugin<'analytics', {
+    actions: EditorAnalyticsAPI;
+    dependencies: [
+        OptionalPlugin<FeatureFlagsPlugin>
+    ];
     pluginConfiguration: AnalyticsPluginOptions;
     sharedState: {
         /**
          * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
          * instead, as it will properly queue all events.
          */
-        createAnalyticsEvent: CreateUIAnalyticsEvent | null;
+        attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
         /**
          * **Warning:** Do not use this directly. Use the `analyticsPlugin.actions`
          * instead, as it will properly queue all events.
          */
-        attachAnalyticsEvent: CreateAttachPayloadIntoTransaction | null;
+        createAnalyticsEvent: CreateUIAnalyticsEvent | null;
         performanceTracking: PerformanceTracking | undefined;
     };
-    dependencies: [
-        OptionalPlugin<FeatureFlagsPlugin>
-    ];
-    actions: EditorAnalyticsAPI;
 }>;

package/dist/types-ts4.5/pm-plugins/analytics-api/attach-payload-into-transaction.d.ts

@@ -1,16 +1,8 @@
 import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
-type AttachPayloadIntoTransaction = (props: {
-    payload: AnalyticsEventPayload;
-    selection: Selection;
-    tr: Transaction;
-    channel: string;
-}) => void;
 export type CreateAttachPayloadIntoTransaction = (props: {
+    channel: string;
     payload: AnalyticsEventPayload;
     tr: Transaction;
-    channel: string;
 }) => void;
 export declare const createAttachPayloadIntoTransaction: (selection: Selection) => CreateAttachPayloadIntoTransaction;
-export declare const attachPayloadIntoTransaction: AttachPayloadIntoTransaction;
-export {};

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

@@ -2,8 +2,7 @@ import type { AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
 import { SELECTION_POSITION, SELECTION_TYPE } from '@atlaskit/editor-common/analytics';
 import type { Selection, Transaction } from '@atlaskit/editor-prosemirror/state';
 export declare function getSelectionType(selection: Selection): {
-    type: SELECTION_TYPE;
     position?: SELECTION_POSITION;
+    type: SELECTION_TYPE;
 };
-export declare function findInsertedLocation(oldSelection: Selection, newSelection: Selection): string;
 export declare function getStateContext(selection: Selection, payload: AnalyticsEventPayload, tr?: Transaction): AnalyticsEventPayload;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-analytics",
-	"version": "3.0.3",
+	"version": "3.0.5",
 	"description": "Analytics plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -30,7 +30,7 @@
 		".": "./src/index.ts"
 	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^50.2.0",
+		"@atlaskit/adf-schema": "^50.2.1",
 		"@atlaskit/analytics-listeners": "^9.0.0",
 		"@atlaskit/analytics-next": "^11.1.0",
 		"@atlaskit/editor-plugin-feature-flags": "^2.0.0",
@@ -39,7 +39,7 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.16.0",
+		"@atlaskit/editor-common": "^107.28.0",
 		"react": "^18.2.0"
 	},
 	"techstack": {