@atlaskit/editor-plugin-block-menu 4.0.8 → 4.0.9

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-plugin-block-menu
 
+## 4.0.9
+
+### Patch Changes
+
+- [`bbb9bb5594379`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bbb9bb5594379) -
+  Add eventCategory attribute in the payload of `elementConverted` event from Block menu
+- Updated dependencies
+
 ## 4.0.8
 
 ### Patch Changes

package/dist/cjs/editor-commands/formatNode.js

@@ -136,6 +136,7 @@ var formatNode = exports.formatNode = function formatNode(api) {
               attributes: {
                 from: sourceTypeName,
                 to: targetType,
+                eventCategory: (0, _utils2.getConversionType)(sourceTypeName, targetType),
                 inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || _analytics.INPUT_METHOD.MOUSE,
                 triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || _analytics.INPUT_METHOD.BLOCK_MENU,
                 conversionSource: 'emptyList'
@@ -176,6 +177,7 @@ var formatNode = exports.formatNode = function formatNode(api) {
               attributes: {
                 from: _sourceTypeName,
                 to: targetType,
+                eventCategory: (0, _utils2.getConversionType)(_sourceTypeName, targetType),
                 inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || _analytics.INPUT_METHOD.MOUSE,
                 triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || _analytics.INPUT_METHOD.BLOCK_MENU,
                 conversionSource: conversionSource
@@ -232,6 +234,7 @@ var formatNode = exports.formatNode = function formatNode(api) {
             attributes: {
               from: _sourceTypeName2,
               to: targetType,
+              eventCategory: (0, _utils2.getConversionType)(_sourceTypeName2, targetType),
               inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || _analytics.INPUT_METHOD.MOUSE,
               triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || _analytics.INPUT_METHOD.BLOCK_MENU
             }

package/dist/cjs/editor-commands/transforms/utils.js

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isListNodeType = exports.isListNode = exports.isLayoutNodeType = exports.isLayoutNode = exports.isHeadingOrParagraphNode = exports.isContainerNodeType = exports.isContainerNode = exports.isBlockNodeType = exports.isBlockNodeForExtraction = exports.isBlockNode = exports.getTargetNodeInfo = exports.getMarksWithBreakout = exports.getContentSupportChecker = exports.filterMarksForTargetNodeType = exports.convertNodeToInlineContent = exports.convertCodeBlockContentToParagraphs = void 0;
+exports.isListNodeType = exports.isListNode = exports.isLayoutNodeType = exports.isLayoutNode = exports.isHeadingOrParagraphNode = exports.isContainerNodeType = exports.isContainerNode = exports.isBlockNodeType = exports.isBlockNodeForExtraction = exports.isBlockNode = exports.getTargetNodeInfo = exports.getMarksWithBreakout = exports.getConversionType = exports.getContentSupportChecker = exports.filterMarksForTargetNodeType = exports.convertNodeToInlineContent = exports.convertCodeBlockContentToParagraphs = void 0;
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _model = require("@atlaskit/editor-prosemirror/model");
 var getTargetNodeInfo = exports.getTargetNodeInfo = function getTargetNodeInfo(targetType, nodes) {
@@ -221,4 +221,38 @@ var getMarksWithBreakout = exports.getMarksWithBreakout = function getMarksWithB
     return hasBreakoutMark ? allowedMarks : [].concat((0, _toConsumableArray2.default)(allowedMarks), [sourceBreakoutMark]);
   }
   return allowedMarks;
+};
+
+/**
+ * Determines the conversion type based on source and target node types
+ * This is for analytics use - these types match existing analytics events for consistency
+ */
+var getConversionType = exports.getConversionType = function getConversionType(from, to) {
+  // Block node insertion: block-like elements inserted from empty line or wrapping text/list
+  var blockNodes = ['panel', 'expand', 'codeBlock', 'layoutSection', 'taskList'];
+  var textNodes = ['paragraph', 'blockquote'];
+  var headingNodes = ['heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
+  var listNodes = ['bulletList', 'orderedList'];
+
+  // Check if converting to block nodes from text/heading/list nodes
+  if (blockNodes.includes(to) && (textNodes.includes(from) || headingNodes.includes(from) || listNodes.includes(from))) {
+    return 'blockNodeInserted';
+  }
+
+  // Check if converting from paragraph/blockquote to list
+  if (listNodes.includes(to) && textNodes.includes(from)) {
+    return 'listInserted';
+  }
+
+  // Check if converting from list to paragraph/heading/blockquote or between list types
+  if (listNodes.includes(from) && (listNodes.includes(to) || textNodes.includes(to))) {
+    return 'listConverted';
+  }
+
+  // Text formatting: conversions among paragraph/headings/blockquote
+  if ((textNodes.includes(from) || headingNodes.includes(from)) && (textNodes.includes(to) || headingNodes.includes(to))) {
+    return 'textFormatted';
+  }
+  // For other conversions, we do not have a matching event category
+  return undefined;
 };

package/dist/es2019/editor-commands/formatNode.js

@@ -7,7 +7,7 @@ import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equ
 import { setSelectionAfterTransform } from './selection';
 import { createDefaultLayoutSection } from './transforms/layout-transforms';
 import { transformNodeToTargetType } from './transforms/transformNodeToTargetType';
-import { isListNodeType } from './transforms/utils';
+import { isListNodeType, getConversionType } from './transforms/utils';
 
 /**
  * Handles formatting when selection is empty by inserting a new target node
@@ -141,6 +141,7 @@ export const formatNode = api => (targetType, analyticsAttrs) => {
             attributes: {
               from: sourceTypeName,
               to: targetType,
+              eventCategory: getConversionType(sourceTypeName, targetType),
               inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.MOUSE,
               triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.BLOCK_MENU,
               conversionSource: 'emptyList'
@@ -181,6 +182,7 @@ export const formatNode = api => (targetType, analyticsAttrs) => {
             attributes: {
               from: sourceTypeName,
               to: targetType,
+              eventCategory: getConversionType(sourceTypeName, targetType),
               inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.MOUSE,
               triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.BLOCK_MENU,
               conversionSource
@@ -237,6 +239,7 @@ export const formatNode = api => (targetType, analyticsAttrs) => {
           attributes: {
             from: sourceTypeName,
             to: targetType,
+            eventCategory: getConversionType(sourceTypeName, targetType),
             inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.MOUSE,
             triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.BLOCK_MENU
           }

package/dist/es2019/editor-commands/transforms/utils.js

@@ -209,4 +209,38 @@ export const getMarksWithBreakout = (sourceNode, targetNodeType) => {
     return hasBreakoutMark ? allowedMarks : [...allowedMarks, sourceBreakoutMark];
   }
   return allowedMarks;
+};
+
+/**
+ * Determines the conversion type based on source and target node types
+ * This is for analytics use - these types match existing analytics events for consistency
+ */
+export const getConversionType = (from, to) => {
+  // Block node insertion: block-like elements inserted from empty line or wrapping text/list
+  const blockNodes = ['panel', 'expand', 'codeBlock', 'layoutSection', 'taskList'];
+  const textNodes = ['paragraph', 'blockquote'];
+  const headingNodes = ['heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
+  const listNodes = ['bulletList', 'orderedList'];
+
+  // Check if converting to block nodes from text/heading/list nodes
+  if (blockNodes.includes(to) && (textNodes.includes(from) || headingNodes.includes(from) || listNodes.includes(from))) {
+    return 'blockNodeInserted';
+  }
+
+  // Check if converting from paragraph/blockquote to list
+  if (listNodes.includes(to) && textNodes.includes(from)) {
+    return 'listInserted';
+  }
+
+  // Check if converting from list to paragraph/heading/blockquote or between list types
+  if (listNodes.includes(from) && (listNodes.includes(to) || textNodes.includes(to))) {
+    return 'listConverted';
+  }
+
+  // Text formatting: conversions among paragraph/headings/blockquote
+  if ((textNodes.includes(from) || headingNodes.includes(from)) && (textNodes.includes(to) || headingNodes.includes(to))) {
+    return 'textFormatted';
+  }
+  // For other conversions, we do not have a matching event category
+  return undefined;
 };

package/dist/esm/editor-commands/formatNode.js

@@ -7,7 +7,7 @@ import { expValEqualsNoExposure } from '@atlaskit/tmp-editor-statsig/exp-val-equ
 import { setSelectionAfterTransform } from './selection';
 import { createDefaultLayoutSection } from './transforms/layout-transforms';
 import { transformNodeToTargetType } from './transforms/transformNodeToTargetType';
-import { isListNodeType } from './transforms/utils';
+import { isListNodeType, getConversionType } from './transforms/utils';
 
 /**
  * Handles formatting when selection is empty by inserting a new target node
@@ -131,6 +131,7 @@ export var formatNode = function formatNode(api) {
               attributes: {
                 from: sourceTypeName,
                 to: targetType,
+                eventCategory: getConversionType(sourceTypeName, targetType),
                 inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.MOUSE,
                 triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.BLOCK_MENU,
                 conversionSource: 'emptyList'
@@ -171,6 +172,7 @@ export var formatNode = function formatNode(api) {
               attributes: {
                 from: _sourceTypeName,
                 to: targetType,
+                eventCategory: getConversionType(_sourceTypeName, targetType),
                 inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.MOUSE,
                 triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.BLOCK_MENU,
                 conversionSource: conversionSource
@@ -227,6 +229,7 @@ export var formatNode = function formatNode(api) {
             attributes: {
               from: _sourceTypeName2,
               to: targetType,
+              eventCategory: getConversionType(_sourceTypeName2, targetType),
               inputMethod: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.inputMethod) || INPUT_METHOD.MOUSE,
               triggeredFrom: (analyticsAttrs === null || analyticsAttrs === void 0 ? void 0 : analyticsAttrs.triggeredFrom) || INPUT_METHOD.BLOCK_MENU
             }

package/dist/esm/editor-commands/transforms/utils.js

@@ -214,4 +214,38 @@ export var getMarksWithBreakout = function getMarksWithBreakout(sourceNode, targ
     return hasBreakoutMark ? allowedMarks : [].concat(_toConsumableArray(allowedMarks), [sourceBreakoutMark]);
   }
   return allowedMarks;
+};
+
+/**
+ * Determines the conversion type based on source and target node types
+ * This is for analytics use - these types match existing analytics events for consistency
+ */
+export var getConversionType = function getConversionType(from, to) {
+  // Block node insertion: block-like elements inserted from empty line or wrapping text/list
+  var blockNodes = ['panel', 'expand', 'codeBlock', 'layoutSection', 'taskList'];
+  var textNodes = ['paragraph', 'blockquote'];
+  var headingNodes = ['heading1', 'heading2', 'heading3', 'heading4', 'heading5', 'heading6'];
+  var listNodes = ['bulletList', 'orderedList'];
+
+  // Check if converting to block nodes from text/heading/list nodes
+  if (blockNodes.includes(to) && (textNodes.includes(from) || headingNodes.includes(from) || listNodes.includes(from))) {
+    return 'blockNodeInserted';
+  }
+
+  // Check if converting from paragraph/blockquote to list
+  if (listNodes.includes(to) && textNodes.includes(from)) {
+    return 'listInserted';
+  }
+
+  // Check if converting from list to paragraph/heading/blockquote or between list types
+  if (listNodes.includes(from) && (listNodes.includes(to) || textNodes.includes(to))) {
+    return 'listConverted';
+  }
+
+  // Text formatting: conversions among paragraph/headings/blockquote
+  if ((textNodes.includes(from) || headingNodes.includes(from)) && (textNodes.includes(to) || headingNodes.includes(to))) {
+    return 'textFormatted';
+  }
+  // For other conversions, we do not have a matching event category
+  return undefined;
 };

package/dist/types/editor-commands/transforms/utils.d.ts

@@ -38,3 +38,8 @@ export declare const filterMarksForTargetNodeType: (content: Fragment, targetNod
  */
 export declare const convertCodeBlockContentToParagraphs: (codeBlockNode: PMNode, schema: Schema) => PMNode[];
 export declare const getMarksWithBreakout: (sourceNode: PMNode, targetNodeType: NodeType) => readonly Mark[];
+/**
+ * Determines the conversion type based on source and target node types
+ * This is for analytics use - these types match existing analytics events for consistency
+ */
+export declare const getConversionType: (from: string, to: string) => "blockNodeInserted" | "listInserted" | "listConverted" | "textFormatted" | undefined;

package/dist/types-ts4.5/editor-commands/transforms/utils.d.ts

@@ -38,3 +38,8 @@ export declare const filterMarksForTargetNodeType: (content: Fragment, targetNod
  */
 export declare const convertCodeBlockContentToParagraphs: (codeBlockNode: PMNode, schema: Schema) => PMNode[];
 export declare const getMarksWithBreakout: (sourceNode: PMNode, targetNodeType: NodeType) => readonly Mark[];
+/**
+ * Determines the conversion type based on source and target node types
+ * This is for analytics use - these types match existing analytics events for consistency
+ */
+export declare const getConversionType: (from: string, to: string) => "blockNodeInserted" | "listInserted" | "listConverted" | "textFormatted" | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "4.0.8",
+	"version": "4.0.9",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",