@atlaskit/editor-plugin-synced-block 10.3.8 → 10.4.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @atlaskit/editor-plugin-synced-block
 
+## 10.4.0
+
+### Minor Changes
+
+- [`b0cecd4d5b970`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b0cecd4d5b970) -
+  Add a product feedback trigger to synced block overflow actions.
+
+### Patch Changes
+
+- Updated dependencies
+
+## 10.3.9
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 10.3.8
 
 ### Patch Changes

package/dist/cjs/syncedBlockPlugin.js

@@ -147,7 +147,7 @@ var syncedBlockPlugin = exports.syncedBlockPlugin = function syncedBlockPlugin(_
         if (!((_syncedBlockPluginKey = _main.syncedBlockPluginKey.getState(state)) !== null && _syncedBlockPluginKey !== void 0 && _syncedBlockPluginKey.hasSyncedBlocks) && isPerfExperimentOn) {
           return undefined;
         }
-        return (0, _floatingToolbar.getToolbarConfig)(state, intl, api, syncBlockStore, config === null || config === void 0 ? void 0 : config.__livePage);
+        return (0, _floatingToolbar.getToolbarConfig)(state, intl, api, syncBlockStore, config === null || config === void 0 ? void 0 : config.__livePage, config === null || config === void 0 ? void 0 : config.onGiveFeedback);
       }
     },
     contentComponent: function contentComponent(_ref4) {

package/dist/cjs/ui/floating-toolbar.js

@@ -6,10 +6,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.getToolbarConfig = void 0;
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = _interopRequireDefault(require("react"));
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _messages = _interopRequireWildcard(require("@atlaskit/editor-common/messages"));
+var _selection = require("@atlaskit/editor-common/selection");
 var _ui = require("@atlaskit/editor-common/ui");
 var _utils = require("@atlaskit/editor-prosemirror/utils");
 var _consts = require("@atlaskit/editor-shared-styles/consts");
@@ -18,6 +20,7 @@ var _copy = _interopRequireDefault(require("@atlaskit/icon/core/copy"));
 var _delete = _interopRequireDefault(require("@atlaskit/icon/core/delete"));
 var _edit = _interopRequireDefault(require("@atlaskit/icon/core/edit"));
 var _linkBroken = _interopRequireDefault(require("@atlaskit/icon/core/link-broken"));
+var _megaphone = _interopRequireDefault(require("@atlaskit/icon/core/megaphone"));
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _editorCommands = require("../editor-commands");
@@ -27,7 +30,7 @@ var _SyncedLocationDropdown = require("./SyncedLocationDropdown");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 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 getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(state, intl, api, syncBlockStore, isLivePage) {
+var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(state, intl, api, syncBlockStore, isLivePage, onGiveFeedback) {
   var _syncBlockInstance$er, _api$decorations, _api$connectivity;
   var syncBlockObject = (0, _utils2.findSyncBlockOrBodiedSyncBlock)(state.schema, state.selection);
   if (!syncBlockObject) {
@@ -171,14 +174,29 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(stat
       var overflowMenuConfig = [{
         type: 'overflow-dropdown',
         testId: testId,
-        options: [_objectSpread({
+        options: [].concat((0, _toConsumableArray2.default)(isSyncBlockActivationEnabled && onGiveFeedback ? [{
+          title: formatMessage(_messages.toolbarInsertBlockMessages.feedbackDialog),
+          icon: /*#__PURE__*/_react.default.createElement(_megaphone.default, {
+            label: ""
+          }),
+          onClick: function onClick() {
+            api === null || api === void 0 || api.core.actions.execute(function (_ref) {
+              var tr = _ref.tr;
+              return tr.setSelection(new _selection.GapCursorSelection(tr.doc.resolve(syncBlockObject.pos + syncBlockObject.node.nodeSize), _selection.Side.RIGHT));
+            });
+            onGiveFeedback({
+              blockType: isBodiedSyncBlock ? 'source' : 'reference'
+            });
+            return true;
+          }
+        }] : []), [_objectSpread({
           title: formatMessage(_messages.default.delete),
           onClick: (0, _editorCommands.removeSyncedBlock)(api),
           icon: /*#__PURE__*/_react.default.createElement(_delete.default, {
             label: ""
           }),
           testId: isBodiedSyncBlock ? _types.SYNCED_BLOCK_BUTTON_TEST_ID.syncedBlockToolbarSourceDelete : _types.SYNCED_BLOCK_BUTTON_TEST_ID.syncedBlockToolbarReferenceDelete
-        }, hoverDecorationProps(nodeType))]
+        }, hoverDecorationProps(nodeType))])
       }];
       items.push.apply(items, overflowMenuConfig);
     }

package/dist/es2019/syncedBlockPlugin.js

@@ -136,7 +136,7 @@ export const syncedBlockPlugin = ({
         if (!((_syncedBlockPluginKey = syncedBlockPluginKey.getState(state)) !== null && _syncedBlockPluginKey !== void 0 && _syncedBlockPluginKey.hasSyncedBlocks) && isPerfExperimentOn) {
           return undefined;
         }
-        return getToolbarConfig(state, intl, api, syncBlockStore, config === null || config === void 0 ? void 0 : config.__livePage);
+        return getToolbarConfig(state, intl, api, syncBlockStore, config === null || config === void 0 ? void 0 : config.__livePage, config === null || config === void 0 ? void 0 : config.onGiveFeedback);
       }
     },
     contentComponent: ({

package/dist/es2019/ui/floating-toolbar.js

@@ -1,6 +1,7 @@
 import React from 'react';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import commonMessages, { syncBlockMessages as messages } from '@atlaskit/editor-common/messages';
+import commonMessages, { syncBlockMessages as messages, toolbarInsertBlockMessages } from '@atlaskit/editor-common/messages';
+import { GapCursorSelection, Side } from '@atlaskit/editor-common/selection';
 import { FloatingToolbarButton as Button } from '@atlaskit/editor-common/ui';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { akEditorSelectedNodeClassName } from '@atlaskit/editor-shared-styles/consts';
@@ -9,13 +10,14 @@ import CopyIcon from '@atlaskit/icon/core/copy';
 import DeleteIcon from '@atlaskit/icon/core/delete';
 import EditIcon from '@atlaskit/icon/core/edit';
 import LinkBrokenIcon from '@atlaskit/icon/core/link-broken';
+import MegaphoneIcon from '@atlaskit/icon/core/megaphone';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { copySyncedBlockReferenceToClipboard, editSyncedBlockSource, removeSyncedBlock, unsync } from '../editor-commands';
 import { findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from '../pm-plugins/utils/utils';
 import { SYNCED_BLOCK_BUTTON_TEST_ID } from '../types';
 import { SyncedLocationDropdown } from './SyncedLocationDropdown';
-export const getToolbarConfig = (state, intl, api, syncBlockStore, isLivePage) => {
+export const getToolbarConfig = (state, intl, api, syncBlockStore, isLivePage, onGiveFeedback) => {
   var _syncBlockInstance$er, _api$decorations, _api$connectivity, _api$connectivity$sha;
   const syncBlockObject = findSyncBlockOrBodiedSyncBlock(state.schema, state.selection);
   if (!syncBlockObject) {
@@ -168,7 +170,21 @@ export const getToolbarConfig = (state, intl, api, syncBlockStore, isLivePage) =
       const overflowMenuConfig = [{
         type: 'overflow-dropdown',
         testId,
-        options: [{
+        options: [...(isSyncBlockActivationEnabled && onGiveFeedback ? [{
+          title: formatMessage(toolbarInsertBlockMessages.feedbackDialog),
+          icon: /*#__PURE__*/React.createElement(MegaphoneIcon, {
+            label: ""
+          }),
+          onClick: () => {
+            api === null || api === void 0 ? void 0 : api.core.actions.execute(({
+              tr
+            }) => tr.setSelection(new GapCursorSelection(tr.doc.resolve(syncBlockObject.pos + syncBlockObject.node.nodeSize), Side.RIGHT)));
+            onGiveFeedback({
+              blockType: isBodiedSyncBlock ? 'source' : 'reference'
+            });
+            return true;
+          }
+        }] : []), {
           title: formatMessage(commonMessages.delete),
           onClick: removeSyncedBlock(api),
           icon: /*#__PURE__*/React.createElement(DeleteIcon, {

package/dist/esm/syncedBlockPlugin.js

@@ -141,7 +141,7 @@ export var syncedBlockPlugin = function syncedBlockPlugin(_ref2) {
         if (!((_syncedBlockPluginKey = syncedBlockPluginKey.getState(state)) !== null && _syncedBlockPluginKey !== void 0 && _syncedBlockPluginKey.hasSyncedBlocks) && isPerfExperimentOn) {
           return undefined;
         }
-        return getToolbarConfig(state, intl, api, syncBlockStore, config === null || config === void 0 ? void 0 : config.__livePage);
+        return getToolbarConfig(state, intl, api, syncBlockStore, config === null || config === void 0 ? void 0 : config.__livePage, config === null || config === void 0 ? void 0 : config.onGiveFeedback);
       }
     },
     contentComponent: function contentComponent(_ref4) {

package/dist/esm/ui/floating-toolbar.js

@@ -1,9 +1,11 @@
+import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
 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 React from 'react';
 import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import commonMessages, { syncBlockMessages as messages } from '@atlaskit/editor-common/messages';
+import commonMessages, { syncBlockMessages as messages, toolbarInsertBlockMessages } from '@atlaskit/editor-common/messages';
+import { GapCursorSelection, Side } from '@atlaskit/editor-common/selection';
 import { FloatingToolbarButton as Button } from '@atlaskit/editor-common/ui';
 import { findDomRefAtPos } from '@atlaskit/editor-prosemirror/utils';
 import { akEditorSelectedNodeClassName } from '@atlaskit/editor-shared-styles/consts';
@@ -12,13 +14,14 @@ import CopyIcon from '@atlaskit/icon/core/copy';
 import DeleteIcon from '@atlaskit/icon/core/delete';
 import EditIcon from '@atlaskit/icon/core/edit';
 import LinkBrokenIcon from '@atlaskit/icon/core/link-broken';
+import MegaphoneIcon from '@atlaskit/icon/core/megaphone';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { copySyncedBlockReferenceToClipboard, editSyncedBlockSource, removeSyncedBlock, unsync } from '../editor-commands';
 import { findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from '../pm-plugins/utils/utils';
 import { SYNCED_BLOCK_BUTTON_TEST_ID } from '../types';
 import { SyncedLocationDropdown } from './SyncedLocationDropdown';
-export var getToolbarConfig = function getToolbarConfig(state, intl, api, syncBlockStore, isLivePage) {
+export var getToolbarConfig = function getToolbarConfig(state, intl, api, syncBlockStore, isLivePage, onGiveFeedback) {
   var _syncBlockInstance$er, _api$decorations, _api$connectivity;
   var syncBlockObject = findSyncBlockOrBodiedSyncBlock(state.schema, state.selection);
   if (!syncBlockObject) {
@@ -162,14 +165,29 @@ export var getToolbarConfig = function getToolbarConfig(state, intl, api, syncBl
       var overflowMenuConfig = [{
         type: 'overflow-dropdown',
         testId: testId,
-        options: [_objectSpread({
+        options: [].concat(_toConsumableArray(isSyncBlockActivationEnabled && onGiveFeedback ? [{
+          title: formatMessage(toolbarInsertBlockMessages.feedbackDialog),
+          icon: /*#__PURE__*/React.createElement(MegaphoneIcon, {
+            label: ""
+          }),
+          onClick: function onClick() {
+            api === null || api === void 0 || api.core.actions.execute(function (_ref) {
+              var tr = _ref.tr;
+              return tr.setSelection(new GapCursorSelection(tr.doc.resolve(syncBlockObject.pos + syncBlockObject.node.nodeSize), Side.RIGHT));
+            });
+            onGiveFeedback({
+              blockType: isBodiedSyncBlock ? 'source' : 'reference'
+            });
+            return true;
+          }
+        }] : []), [_objectSpread({
           title: formatMessage(commonMessages.delete),
           onClick: removeSyncedBlock(api),
           icon: /*#__PURE__*/React.createElement(DeleteIcon, {
             label: ""
           }),
           testId: isBodiedSyncBlock ? SYNCED_BLOCK_BUTTON_TEST_ID.syncedBlockToolbarSourceDelete : SYNCED_BLOCK_BUTTON_TEST_ID.syncedBlockToolbarReferenceDelete
-        }, hoverDecorationProps(nodeType))]
+        }, hoverDecorationProps(nodeType))])
       }];
       items.push.apply(items, overflowMenuConfig);
     }

package/dist/types/entry-points/synced-block-plugin-type.d.ts

@@ -1 +1 @@
-export type { SyncedBlockPlugin, SyncedBlockPluginOptions, SyncedBlockEditorProps, SyncedBlockRendererProps, } from '../syncedBlockPluginType';
+export type { SyncedBlockFeedbackContext, SyncedBlockPlugin, SyncedBlockPluginOptions, SyncedBlockEditorProps, SyncedBlockRendererProps, } from '../syncedBlockPluginType';

package/dist/types/syncedBlockPluginType.d.ts

@@ -43,6 +43,10 @@ export type SyncedBlockRendererProps = {
     api?: ExtractInjectionAPI<SyncedBlockPlugin>;
     syncBlockFetchResult: UseFetchSyncBlockDataResult;
 };
+export type SyncedBlockFeedbackContext = {
+    blockType: 'source' | 'reference';
+    entryPoint?: string;
+};
 export interface SyncedBlockPluginOptions extends LongPressSelectionPluginOptions {
     /**
      * Enables Live Page specific behaviour for the synced block plugin.
@@ -53,6 +57,12 @@ export interface SyncedBlockPluginOptions extends LongPressSelectionPluginOption
      */
     __livePage?: boolean;
     enableSourceCreation?: boolean;
+    /**
+     * Opens the host product's synced-block feedback collector.
+     * The editor plugin owns the menu affordance; the product owns the collector
+     * configuration and lifecycle.
+     */
+    onGiveFeedback?: (context: SyncedBlockFeedbackContext) => void;
     syncBlockDataProvider: SyncBlockDataProviderInterface;
     syncedBlockRenderer: (props: SyncedBlockRendererProps) => React.JSX.Element;
 }

package/dist/types/ui/floating-toolbar.d.ts

@@ -2,5 +2,5 @@ import type { IntlShape } from 'react-intl';
 import type { ExtractInjectionAPI, FloatingToolbarConfig } from '@atlaskit/editor-common/types';
 import type { EditorState } from '@atlaskit/editor-prosemirror/state';
 import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
-import type { SyncedBlockPlugin } from '../syncedBlockPluginType';
-export declare const getToolbarConfig: (state: EditorState, intl: IntlShape, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined, syncBlockStore: SyncBlockStoreManager, isLivePage?: boolean) => FloatingToolbarConfig | undefined;
+import type { SyncedBlockFeedbackContext, SyncedBlockPlugin } from '../syncedBlockPluginType';
+export declare const getToolbarConfig: (state: EditorState, intl: IntlShape, api: ExtractInjectionAPI<SyncedBlockPlugin> | undefined, syncBlockStore: SyncBlockStoreManager, isLivePage?: boolean, onGiveFeedback?: (context: SyncedBlockFeedbackContext) => void) => FloatingToolbarConfig | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-synced-block",
-	"version": "10.3.8",
+	"version": "10.4.0",
 	"description": "SyncedBlock plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -46,8 +46,8 @@
 		"@atlaskit/platform-feature-flags": "^2.1.0",
 		"@atlaskit/primitives": "^22.1.0",
 		"@atlaskit/spinner": "20.1.1",
-		"@atlaskit/tmp-editor-statsig": "^132.1.0",
-		"@atlaskit/tokens": "16.2.0",
+		"@atlaskit/tmp-editor-statsig": "^132.4.0",
+		"@atlaskit/tokens": "16.3.0",
 		"@atlaskit/tooltip": "^23.1.0",
 		"@atlaskit/visually-hidden": "^4.2.0",
 		"@babel/runtime": "^7.0.0",
@@ -57,7 +57,7 @@
 		"memoize-one": "^6.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.35.0",
+		"@atlaskit/editor-common": "^116.37.0",
 		"react": "^18.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},