@atlaskit/editor-plugin-synced-block 3.8.2 → 3.9.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-plugin-synced-block
 
+## 3.9.0
+
+### Minor Changes
+
+- [`49860e3111ce8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/49860e3111ce8) -
+  [ux] [EDITOR-2481] Implement plugin action flushBodiedSyncBlocks so that bodied sync block content
+  is only updated when required
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 3.8.2
 
 ### Patch Changes

package/dist/cjs/editor-actions/index.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.flushBodiedSyncBlocks = void 0;
+var flushBodiedSyncBlocks = exports.flushBodiedSyncBlocks = function flushBodiedSyncBlocks(syncBlockStore) {
+  return syncBlockStore.flushBodiedSyncBlocks();
+};

package/dist/cjs/{pm-plugins/actions.js → editor-commands/index.js}

@@ -9,7 +9,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
 var _analytics = require("@atlaskit/editor-common/analytics");
 var _copyButton = require("@atlaskit/editor-common/copy-button");
 var _utils = require("@atlaskit/editor-prosemirror/utils");
-var _utils2 = require("./utils/utils");
+var _utils2 = require("../pm-plugins/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 createSyncedBlock = exports.createSyncedBlock = function createSyncedBlock(_ref) {

package/dist/cjs/syncedBlockPlugin.js

@@ -10,7 +10,8 @@ var _adfSchema = require("@atlaskit/adf-schema");
 var _messages = require("@atlaskit/editor-common/messages");
 var _quickInsert = require("@atlaskit/editor-common/quick-insert");
 var _editorSyncedBlockProvider = require("@atlaskit/editor-synced-block-provider");
-var _actions = require("./pm-plugins/actions");
+var _editorActions = require("./editor-actions");
+var _editorCommands = require("./editor-commands");
 var _main = require("./pm-plugins/main");
 var _blockMenuComponents = require("./ui/block-menu-components");
 var _ContentComponent = require("./ui/ContentComponent");
@@ -44,13 +45,18 @@ var syncedBlockPlugin = exports.syncedBlockPlugin = function syncedBlockPlugin(_
       insertSyncedBlock: function insertSyncedBlock() {
         return function (_ref2) {
           var tr = _ref2.tr;
-          return (0, _actions.createSyncedBlock)({
+          return (0, _editorCommands.createSyncedBlock)({
             tr: tr,
             syncBlockStore: syncBlockStore
           }) || null;
         };
       }
     },
+    actions: {
+      flushBodiedSyncBlocks: function flushBodiedSyncBlocks() {
+        return (0, _editorActions.flushBodiedSyncBlocks)(syncBlockStore);
+      }
+    },
     pluginsOptions: {
       quickInsert: function quickInsert(_ref3) {
         var formatMessage = _ref3.formatMessage;
@@ -67,7 +73,7 @@ var syncedBlockPlugin = exports.syncedBlockPlugin = function syncedBlockPlugin(_
             });
           },
           action: function action(insert, state) {
-            return (0, _actions.createSyncedBlock)({
+            return (0, _editorCommands.createSyncedBlock)({
               tr: state.tr,
               syncBlockStore: syncBlockStore,
               typeAheadInsert: insert

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

@@ -14,7 +14,7 @@ var _consts = require("@atlaskit/editor-shared-styles/consts");
 var _copy = _interopRequireDefault(require("@atlaskit/icon/core/copy"));
 var _delete = _interopRequireDefault(require("@atlaskit/icon/core/delete"));
 var _linkExternal = _interopRequireDefault(require("@atlaskit/icon/core/link-external"));
-var _actions = require("../pm-plugins/actions");
+var _editorCommands = require("../editor-commands");
 var _utils2 = require("../pm-plugins/utils/utils");
 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; }
@@ -51,7 +51,7 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(stat
     title: formatMessage(_messages.syncBlockMessages.copySyncBlockLabel),
     showTitle: true,
     tooltipContent: formatMessage(_messages.syncBlockMessages.copySyncBlockTooltip),
-    onClick: (0, _actions.copySyncedBlockReferenceToClipboard)(api)
+    onClick: (0, _editorCommands.copySyncedBlockReferenceToClipboard)(api)
   }, hoverDecorationProps(nodeType, _consts.akEditorSelectedNodeClassName));
   items.push(copyButton);
   var disabled = !syncBlockStore.getSyncBlockURL(syncBlockObject.node.attrs.localId);
@@ -65,7 +65,7 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(stat
       title: formatMessage(_messages.syncBlockMessages.editSourceLabel),
       showTitle: true,
       tooltipContent: disabled ? formatMessage(_messages.syncBlockMessages.editSourceTooltipDisabled) : formatMessage(_messages.syncBlockMessages.editSourceTooltip),
-      onClick: (0, _actions.editSyncedBlockSource)(syncBlockStore, api)
+      onClick: (0, _editorCommands.editSyncedBlockSource)(syncBlockStore, api)
     }, hoverDecorationProps(nodeType, _consts.akEditorSelectedNodeClassName));
     items.push(editSourceButton);
   }
@@ -81,7 +81,7 @@ var getToolbarConfig = exports.getToolbarConfig = function getToolbarConfig(stat
     testId: testId,
     options: [_objectSpread({
       title: formatMessage(_messages.default.delete),
-      onClick: (0, _actions.removeSyncedBlock)(api),
+      onClick: (0, _editorCommands.removeSyncedBlock)(api),
       icon: /*#__PURE__*/_react.default.createElement(_delete.default, {
         label: ""
       })

package/dist/es2019/editor-actions/index.js

@@ -0,0 +1,3 @@
+export const flushBodiedSyncBlocks = syncBlockStore => {
+  return syncBlockStore.flushBodiedSyncBlocks();
+};

package/dist/es2019/{pm-plugins/actions.js → editor-commands/index.js}

@@ -1,7 +1,7 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { copyDomNode, toDOM } from '@atlaskit/editor-common/copy-button';
 import { findSelectedNodeOfType, removeParentNodeOfType, removeSelectedNode } from '@atlaskit/editor-prosemirror/utils';
-import { canBeConvertedToSyncBlock, findSyncBlock, findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from './utils/utils';
+import { canBeConvertedToSyncBlock, findSyncBlock, findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from '../pm-plugins/utils/utils';
 export const createSyncedBlock = ({
   tr,
   syncBlockStore,

package/dist/es2019/syncedBlockPlugin.js

@@ -3,7 +3,8 @@ import { bodiedSyncBlock, syncBlock } from '@atlaskit/adf-schema';
 import { blockTypeMessages } from '@atlaskit/editor-common/messages';
 import { IconSyncBlock } from '@atlaskit/editor-common/quick-insert';
 import { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
-import { createSyncedBlock } from './pm-plugins/actions';
+import { flushBodiedSyncBlocks } from './editor-actions';
+import { createSyncedBlock } from './editor-commands';
 import { createPlugin } from './pm-plugins/main';
 import { getBlockMenuComponents } from './ui/block-menu-components';
 import { ContentComponent } from './ui/ContentComponent';
@@ -40,6 +41,11 @@ export const syncedBlockPlugin = ({
         syncBlockStore
       }) || null
     },
+    actions: {
+      flushBodiedSyncBlocks: () => {
+        return flushBodiedSyncBlocks(syncBlockStore);
+      }
+    },
     pluginsOptions: {
       quickInsert: ({
         formatMessage

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

@@ -5,7 +5,7 @@ import { akEditorSelectedNodeClassName } from '@atlaskit/editor-shared-styles/co
 import CopyIcon from '@atlaskit/icon/core/copy';
 import DeleteIcon from '@atlaskit/icon/core/delete';
 import LinkExternalIcon from '@atlaskit/icon/core/link-external';
-import { copySyncedBlockReferenceToClipboard, editSyncedBlockSource, removeSyncedBlock } from '../pm-plugins/actions';
+import { copySyncedBlockReferenceToClipboard, editSyncedBlockSource, removeSyncedBlock } from '../editor-commands';
 import { findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from '../pm-plugins/utils/utils';
 export const getToolbarConfig = (state, intl, _options = {}, _providerFactory, api, syncBlockStore) => {
   var _api$decorations;

package/dist/esm/editor-actions/index.js

@@ -0,0 +1,3 @@
+export var flushBodiedSyncBlocks = function flushBodiedSyncBlocks(syncBlockStore) {
+  return syncBlockStore.flushBodiedSyncBlocks();
+};

package/dist/esm/{pm-plugins/actions.js → editor-commands/index.js}

@@ -4,7 +4,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, EVENT_TYPE } from '@atlaskit/editor-common/analytics';
 import { copyDomNode, toDOM } from '@atlaskit/editor-common/copy-button';
 import { findSelectedNodeOfType, removeParentNodeOfType, removeSelectedNode } from '@atlaskit/editor-prosemirror/utils';
-import { canBeConvertedToSyncBlock, findSyncBlock, findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from './utils/utils';
+import { canBeConvertedToSyncBlock, findSyncBlock, findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from '../pm-plugins/utils/utils';
 export var createSyncedBlock = function createSyncedBlock(_ref) {
   var tr = _ref.tr,
     syncBlockStore = _ref.syncBlockStore,

package/dist/esm/syncedBlockPlugin.js

@@ -3,7 +3,8 @@ import { bodiedSyncBlock, syncBlock } from '@atlaskit/adf-schema';
 import { blockTypeMessages } from '@atlaskit/editor-common/messages';
 import { IconSyncBlock } from '@atlaskit/editor-common/quick-insert';
 import { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
-import { createSyncedBlock } from './pm-plugins/actions';
+import { flushBodiedSyncBlocks as _flushBodiedSyncBlocks } from './editor-actions';
+import { createSyncedBlock } from './editor-commands';
 import { createPlugin } from './pm-plugins/main';
 import { getBlockMenuComponents } from './ui/block-menu-components';
 import { ContentComponent } from './ui/ContentComponent';
@@ -44,6 +45,11 @@ export var syncedBlockPlugin = function syncedBlockPlugin(_ref) {
         };
       }
     },
+    actions: {
+      flushBodiedSyncBlocks: function flushBodiedSyncBlocks() {
+        return _flushBodiedSyncBlocks(syncBlockStore);
+      }
+    },
     pluginsOptions: {
       quickInsert: function quickInsert(_ref3) {
         var formatMessage = _ref3.formatMessage;

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

@@ -8,7 +8,7 @@ import { akEditorSelectedNodeClassName } from '@atlaskit/editor-shared-styles/co
 import CopyIcon from '@atlaskit/icon/core/copy';
 import DeleteIcon from '@atlaskit/icon/core/delete';
 import LinkExternalIcon from '@atlaskit/icon/core/link-external';
-import { copySyncedBlockReferenceToClipboard, editSyncedBlockSource, removeSyncedBlock } from '../pm-plugins/actions';
+import { copySyncedBlockReferenceToClipboard, editSyncedBlockSource, removeSyncedBlock } from '../editor-commands';
 import { findSyncBlockOrBodiedSyncBlock, isBodiedSyncBlockNode } from '../pm-plugins/utils/utils';
 export var getToolbarConfig = function getToolbarConfig(state, intl) {
   var _api$decorations;

package/dist/types/editor-actions/index.d.ts

@@ -0,0 +1,2 @@
+import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
+export declare const flushBodiedSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;

package/dist/types/syncedBlockPluginType.d.ts

@@ -40,6 +40,16 @@ export type SyncedBlockPluginOptions = {
     getSyncedBlockRenderer?: (props: SyncedBlockRendererProps) => React.JSX.Element;
 };
 export type SyncedBlockPlugin = NextEditorPlugin<'syncedBlock', {
+    actions: {
+        /**
+         * Save content of bodiedSyncBlock nodes in local cache to backend.
+         * This action allows bodiedSyncBlock to be saved in sync with product saving experience
+         * as per {@link https://hello.atlassian.net/wiki/spaces/egcuc/pages/5932393240/Synced+Blocks+Save+refresh+principles}
+         *
+         * @returns true if saving all nodes successfully, false if fail to save some/all nodes
+         */
+        flushBodiedSyncBlocks: () => Promise<boolean>;
+    };
     commands: {
         insertSyncedBlock: () => EditorCommand;
     };

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

@@ -0,0 +1,2 @@
+import type { SyncBlockStoreManager } from '@atlaskit/editor-synced-block-provider';
+export declare const flushBodiedSyncBlocks: (syncBlockStore: SyncBlockStoreManager) => Promise<boolean>;

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

@@ -40,6 +40,16 @@ export type SyncedBlockPluginOptions = {
     getSyncedBlockRenderer?: (props: SyncedBlockRendererProps) => React.JSX.Element;
 };
 export type SyncedBlockPlugin = NextEditorPlugin<'syncedBlock', {
+    actions: {
+        /**
+         * Save content of bodiedSyncBlock nodes in local cache to backend.
+         * This action allows bodiedSyncBlock to be saved in sync with product saving experience
+         * as per {@link https://hello.atlassian.net/wiki/spaces/egcuc/pages/5932393240/Synced+Blocks+Save+refresh+principles}
+         *
+         * @returns true if saving all nodes successfully, false if fail to save some/all nodes
+         */
+        flushBodiedSyncBlocks: () => Promise<boolean>;
+    };
     commands: {
         insertSyncedBlock: () => EditorCommand;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-synced-block",
-	"version": "3.8.2",
+	"version": "3.9.0",
 	"description": "SyncedBlock plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -38,7 +38,7 @@
 		"@atlaskit/editor-plugin-selection": "^6.1.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/editor-shared-styles": "^3.8.0",
-		"@atlaskit/editor-synced-block-provider": "^2.1.0",
+		"@atlaskit/editor-synced-block-provider": "^2.2.0",
 		"@atlaskit/editor-tables": "^2.9.0",
 		"@atlaskit/editor-toolbar": "^0.16.0",
 		"@atlaskit/icon": "28.5.3",