@atlaskit/editor-plugin-block-menu 11.0.5 → 11.1.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-block-menu
 
+## 11.1.0
+
+### Minor Changes
+
+- [`b483e293da76f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b483e293da76f) -
+  Add a gated `isSuggested` attribute to block menu element transformed analytics events so
+  suggested and non-suggested transform selections can be distinguished. The event attribute is
+  gated behind the `platform_editor_blocks_patch_2` feature gate.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 11.0.5
 
 ### Patch Changes

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

@@ -1,9 +1,11 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.transformNode = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _expand = require("@atlaskit/editor-common/expand");
 var _monitoring = require("@atlaskit/editor-common/monitoring");
@@ -16,6 +18,8 @@ var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _isNestedNode = require("../ui/utils/isNestedNode");
 var _transform2 = require("./transform-node-utils/transform");
 var _utils = require("./transform-node-utils/utils");
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var transformNode = exports.transformNode = function transformNode(api) {
   return function (targetType, metadata) {
     return function (_ref) {
@@ -44,6 +48,7 @@ var transformNode = exports.transformNode = function transformNode(api) {
 
       // Check if source node is empty paragraph or heading
       var isEmptyLine = sourceNodes.length === 1 && (sourceNodes[0].type === nodes.paragraph || sourceNodes[0].type === nodes.heading) && (sourceNodes[0].content.size === 0 || sourceNodes[0].textContent.trim() === '');
+      var isSuggested = Boolean(metadata === null || metadata === void 0 ? void 0 : metadata.isSuggested);
       try {
         var resultNodes = (0, _transform2.convertNodesToTargetType)({
           sourceNodes: sourceNodes,
@@ -113,10 +118,13 @@ var transformNode = exports.transformNode = function transformNode(api) {
           api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || _api$analytics.attachAnalyticsEvent({
             action: _analytics.ACTION.TRANSFORMED,
             actionSubject: _analytics.ACTION_SUBJECT.ELEMENT,
-            attributes: {
+            attributes: _objectSpread(_objectSpread({
               duration: duration,
               isEmptyLine: isEmptyLine,
-              isNested: isNested,
+              isNested: isNested
+            }, (0, _platformFeatureFlags.fg)('platform_editor_blocks_patch_2') ? {
+              isSuggested: isSuggested
+            } : {}), {}, {
               sourceNodesCount: sourceNodes.length,
               sourceNodesCountByType: sourceNodeTypes,
               sourceNodeType: sourceNodes.length === 1 ? sourceNodes[0].type.name : 'multiple',
@@ -124,7 +132,7 @@ var transformNode = exports.transformNode = function transformNode(api) {
               targetNodeType: targetType.name,
               outputNodesCount: content.length,
               inputMethod: _analytics.INPUT_METHOD.BLOCK_MENU
-            },
+            }),
             eventType: _analytics.EVENT_TYPE.TRACK
           })(tr);
         });

package/dist/cjs/ui/suggested-menu-items.js

@@ -13,7 +13,8 @@ var SuggestedMenuItems = exports.SuggestedMenuItems = /*#__PURE__*/_react.defaul
   return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, suggestedItems.map(function (item) {
     var ItemComponent = item.component;
     return ItemComponent ? /*#__PURE__*/_react.default.createElement(ItemComponent, {
-      key: item.key
+      key: item.key,
+      isSuggested: true
     }) : null;
   }));
 });

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

@@ -40,6 +40,7 @@ export const transformNode = api => (targetType, metadata) => ({
 
   // Check if source node is empty paragraph or heading
   const isEmptyLine = sourceNodes.length === 1 && (sourceNodes[0].type === nodes.paragraph || sourceNodes[0].type === nodes.heading) && (sourceNodes[0].content.size === 0 || sourceNodes[0].textContent.trim() === '');
+  const isSuggested = Boolean(metadata === null || metadata === void 0 ? void 0 : metadata.isSuggested);
   try {
     const resultNodes = convertNodesToTargetType({
       sourceNodes,
@@ -111,6 +112,9 @@ export const transformNode = api => (targetType, metadata) => ({
           duration,
           isEmptyLine,
           isNested,
+          ...(fg('platform_editor_blocks_patch_2') ? {
+            isSuggested
+          } : {}),
           sourceNodesCount: sourceNodes.length,
           sourceNodesCountByType: sourceNodeTypes,
           sourceNodeType: sourceNodes.length === 1 ? sourceNodes[0].type.name : 'multiple',

package/dist/es2019/ui/suggested-menu-items.js

@@ -7,7 +7,8 @@ export const SuggestedMenuItems = /*#__PURE__*/React.memo(({
   return /*#__PURE__*/React.createElement(React.Fragment, null, suggestedItems.map(item => {
     const ItemComponent = item.component;
     return ItemComponent ? /*#__PURE__*/React.createElement(ItemComponent, {
-      key: item.key
+      key: item.key,
+      isSuggested: true
     }) : null;
   }));
 });

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

@@ -1,3 +1,6 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE, INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 import { expandedState } from '@atlaskit/editor-common/expand';
 import { logException } from '@atlaskit/editor-common/monitoring';
@@ -38,6 +41,7 @@ export var transformNode = function transformNode(api) {
 
       // Check if source node is empty paragraph or heading
       var isEmptyLine = sourceNodes.length === 1 && (sourceNodes[0].type === nodes.paragraph || sourceNodes[0].type === nodes.heading) && (sourceNodes[0].content.size === 0 || sourceNodes[0].textContent.trim() === '');
+      var isSuggested = Boolean(metadata === null || metadata === void 0 ? void 0 : metadata.isSuggested);
       try {
         var resultNodes = convertNodesToTargetType({
           sourceNodes: sourceNodes,
@@ -107,10 +111,13 @@ export var transformNode = function transformNode(api) {
           api === null || api === void 0 || (_api$analytics = api.analytics) === null || _api$analytics === void 0 || (_api$analytics = _api$analytics.actions) === null || _api$analytics === void 0 || _api$analytics.attachAnalyticsEvent({
             action: ACTION.TRANSFORMED,
             actionSubject: ACTION_SUBJECT.ELEMENT,
-            attributes: {
+            attributes: _objectSpread(_objectSpread({
               duration: duration,
               isEmptyLine: isEmptyLine,
-              isNested: isNested,
+              isNested: isNested
+            }, fg('platform_editor_blocks_patch_2') ? {
+              isSuggested: isSuggested
+            } : {}), {}, {
               sourceNodesCount: sourceNodes.length,
               sourceNodesCountByType: sourceNodeTypes,
               sourceNodeType: sourceNodes.length === 1 ? sourceNodes[0].type.name : 'multiple',
@@ -118,7 +125,7 @@ export var transformNode = function transformNode(api) {
               targetNodeType: targetType.name,
               outputNodesCount: content.length,
               inputMethod: INPUT_METHOD.BLOCK_MENU
-            },
+            }),
             eventType: EVENT_TYPE.TRACK
           })(tr);
         });

package/dist/esm/ui/suggested-menu-items.js

@@ -6,7 +6,8 @@ export var SuggestedMenuItems = /*#__PURE__*/React.memo(function (_ref) {
   return /*#__PURE__*/React.createElement(React.Fragment, null, suggestedItems.map(function (item) {
     var ItemComponent = item.component;
     return ItemComponent ? /*#__PURE__*/React.createElement(ItemComponent, {
-      key: item.key
+      key: item.key,
+      isSuggested: true
     }) : null;
   }));
 });

package/dist/types/blockMenuPluginType.d.ts

@@ -104,7 +104,13 @@ export type BlockMenuSectionComponent = (props: {
 export type BlockMenuNestedSectionComponent = (props: {
     children: React.ReactNode;
 }) => React.ReactNode;
-export type BlockMenuItemComponent = () => React.ReactNode;
+export type BlockMenuItemComponentProps = {
+    /**
+     * TODO: Make this required when cleaning up platform_editor_blocks_patch_2.
+     */
+    isSuggested?: boolean;
+};
+export type BlockMenuItemComponent = (props?: BlockMenuItemComponentProps) => React.ReactNode;
 export type RegisterBlockMenuNested = BlockMenuNested & {
     component?: BlockMenuNestedComponent;
     isHidden?: () => boolean;

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

@@ -2,6 +2,7 @@ import type { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
 export type TransfromNodeTargetType = 'heading1' | 'heading2' | 'heading3' | 'heading4' | 'heading5' | 'heading6' | 'paragraph' | 'blockquote' | 'expand' | 'layoutSection' | 'panel' | 'panel_c1' | 'codeBlock' | 'bulletList' | 'orderedList' | 'taskList' | 'decisionList';
 export type TransformNodeMetadata = {
     inputMethod: INPUT_METHOD.BLOCK_MENU;
+    isSuggested?: boolean;
     targetAttrs?: Record<string, unknown>;
     targetTypeName: TransfromNodeTargetType;
     triggeredFrom: INPUT_METHOD.MOUSE | INPUT_METHOD.KEYBOARD;

package/dist/types/entry-points/blockMenuPluginType.d.ts

@@ -1 +1 @@
-export type { BlockMenuPlugin, RegisterBlockMenuComponent, Parent, BlockMenuPluginOptions, BlockMenuSharedState, } from '../blockMenuPluginType';
+export type { BlockMenuPlugin, RegisterBlockMenuComponent, BlockMenuItemComponentProps, BlockMenuItemComponent, Parent, BlockMenuPluginOptions, BlockMenuSharedState, } from '../blockMenuPluginType';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-menu",
-	"version": "11.0.5",
+	"version": "11.1.0",
 	"description": "BlockMenu plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -36,13 +36,13 @@
 		"@atlaskit/platform-feature-flags": "^2.0.0",
 		"@atlaskit/primitives": "^20.0.0",
 		"@atlaskit/prosemirror-history": "^1.0.0",
-		"@atlaskit/tmp-editor-statsig": "^109.0.0",
-		"@atlaskit/tokens": "^14.0.0",
+		"@atlaskit/tmp-editor-statsig": "^110.0.0",
+		"@atlaskit/tokens": "^15.0.0",
 		"@babel/runtime": "^7.0.0",
 		"bind-event-listener": "^3.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.6.0",
+		"@atlaskit/editor-common": "^116.11.0",
 		"react": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
@@ -101,6 +101,9 @@
 		"platform_editor_block_menu_v2_patch_2": {
 			"type": "boolean"
 		},
+		"platform_editor_blocks_patch_2": {
+			"type": "boolean"
+		},
 		"cc-maui-phase-3": {
 			"type": "boolean"
 		}
@@ -108,6 +111,6 @@
 	"devDependencies": {
 		"@atlassian/structured-docs-types": "workspace:^",
 		"react": "^18.2.0",
-		"react-intl": "^6.6.2"
+		"react-intl": "^7.0.0"
 	}
 }