@atlaskit/editor-synced-block-provider 2.11.0 → 2.11.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.11.1
+
+### Patch Changes
+
+- [`99387f7d6303b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/99387f7d6303b) -
+  [ux] [EDITOR-2767] Implement bodiedSyncBlock creation/deletion undo/redo
+
 ## 2.11.0
 
 ### Minor Changes

package/dist/cjs/store-manager/sourceSyncBlockStoreManager.js

@@ -12,9 +12,10 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _uuid = _interopRequireDefault(require("uuid"));
 var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _utils = require("@atlaskit/editor-common/utils");
 var _rebaseTransaction2 = require("../common/rebase-transaction");
 var _errorHandling = require("../utils/errorHandling");
-var _utils = require("../utils/utils");
+var _utils2 = require("../utils/utils");
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
 // Designed to manage local in-memory state and synchronize with an external data provider.
@@ -58,7 +59,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         if (!localId || !resourceId) {
           throw new Error('Local ID or resource ID is not set');
         }
-        var syncBlockData = (0, _utils.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode);
+        var syncBlockData = (0, _utils2.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode);
         this.syncBlockCache.set(resourceId, syncBlockData);
         return true;
       } catch (error) {
@@ -246,7 +247,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         }
         var resourceId = attrs.resourceId,
           blockInstanceId = attrs.localId;
-        this.dataProvider.writeNodesData([(0, _utils.createBodiedSyncBlockNode)(blockInstanceId, resourceId)], [{
+        this.dataProvider.writeNodesData([(0, _utils2.createBodiedSyncBlockNode)(blockInstanceId, resourceId)], [{
           content: [],
           blockInstanceId: blockInstanceId,
           resourceId: resourceId
@@ -286,12 +287,12 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: function () {
       var _deleteSyncBlocksWithConfirmation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(tr, syncBlockIds) {
         var _this5 = this;
-        var confirmed, _this$editorView, results, callback, _this$fireAnalyticsEv4;
+        var confirmed, _this$editorView, trToDispatch, results, callback, _this$fireAnalyticsEv4;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
               if (!this.confirmationCallback) {
-                _context2.next = 24;
+                _context2.next = 26;
                 break;
               }
               this.confirmationTransaction = tr;
@@ -300,25 +301,31 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
             case 4:
               confirmed = _context2.sent;
               if (!confirmed) {
-                _context2.next = 23;
+                _context2.next = 25;
                 break;
               }
-              (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true));
-              _context2.prev = 7;
+              trToDispatch = this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true);
+              if (!trToDispatch.getMeta(_utils.pmHistoryPluginKey)) {
+                // bodiedSyncBlock deletion is expected to be permanent (cannot be undo)
+                // For a normal delete (not triggered by undo), remove it from history so that it cannot be undone
+                trToDispatch.setMeta('addToHistory', false);
+              }
+              (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(trToDispatch);
+              _context2.prev = 9;
               if (this.dataProvider) {
-                _context2.next = 10;
+                _context2.next = 12;
                 break;
               }
               throw new Error('Data provider not set');
-            case 10:
+            case 12:
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, true);
               });
-              _context2.next = 13;
+              _context2.next = 15;
               return this.dataProvider.deleteNodesData(syncBlockIds.map(function (attrs) {
                 return attrs.resourceId;
               }));
-            case 13:
+            case 15:
               results = _context2.sent;
               if (results.every(function (result) {
                 return result.success;
@@ -338,11 +345,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 });
               }
               syncBlockIds.forEach(callback);
-              _context2.next = 23;
+              _context2.next = 25;
               break;
-            case 18:
-              _context2.prev = 18;
-              _context2.t0 = _context2["catch"](7);
+            case 20:
+              _context2.prev = 20;
+              _context2.t0 = _context2["catch"](9);
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, false);
               });
@@ -350,13 +357,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
               (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, (0, _errorHandling.deleteErrorPayload)(_context2.t0.message));
-            case 23:
+            case 25:
               this.confirmationTransaction = undefined;
-            case 24:
+            case 26:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[7, 18]]);
+        }, _callee2, this, [[9, 20]]);
       }));
       function deleteSyncBlocksWithConfirmation(_x, _x2) {
         return _deleteSyncBlocksWithConfirmation.apply(this, arguments);

package/dist/es2019/store-manager/sourceSyncBlockStoreManager.js

@@ -2,6 +2,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import uuid from 'uuid';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { pmHistoryPluginKey } from '@atlaskit/editor-common/utils';
 import { rebaseTransaction } from '../common/rebase-transaction';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
 import { convertSyncBlockPMNodeToSyncBlockData, createBodiedSyncBlockNode } from '../utils/utils';
@@ -217,7 +218,13 @@ export class SourceSyncBlockStoreManager {
       const confirmed = await this.confirmationCallback(syncBlockIds.length);
       if (confirmed) {
         var _this$editorView;
-        (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.dispatch(this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true));
+        const trToDispatch = this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true);
+        if (!trToDispatch.getMeta(pmHistoryPluginKey)) {
+          // bodiedSyncBlock deletion is expected to be permanent (cannot be undo)
+          // For a normal delete (not triggered by undo), remove it from history so that it cannot be undone
+          trToDispatch.setMeta('addToHistory', false);
+        }
+        (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.dispatch(trToDispatch);
         try {
           if (!this.dataProvider) {
             throw new Error('Data provider not set');

package/dist/esm/store-manager/sourceSyncBlockStoreManager.js

@@ -6,6 +6,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 // eslint-disable-next-line @atlaskit/platform/prefer-crypto-random-uuid -- Use crypto.randomUUID instead
 import uuid from 'uuid';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { pmHistoryPluginKey } from '@atlaskit/editor-common/utils';
 import { rebaseTransaction as _rebaseTransaction } from '../common/rebase-transaction';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
 import { convertSyncBlockPMNodeToSyncBlockData, createBodiedSyncBlockNode as _createBodiedSyncBlockNode } from '../utils/utils';
@@ -279,12 +280,12 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function () {
       var _deleteSyncBlocksWithConfirmation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(tr, syncBlockIds) {
         var _this5 = this;
-        var confirmed, _this$editorView, results, callback, _this$fireAnalyticsEv4;
+        var confirmed, _this$editorView, trToDispatch, results, callback, _this$fireAnalyticsEv4;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
               if (!this.confirmationCallback) {
-                _context2.next = 24;
+                _context2.next = 26;
                 break;
               }
               this.confirmationTransaction = tr;
@@ -293,25 +294,31 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
             case 4:
               confirmed = _context2.sent;
               if (!confirmed) {
-                _context2.next = 23;
+                _context2.next = 25;
                 break;
               }
-              (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true));
-              _context2.prev = 7;
+              trToDispatch = this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true);
+              if (!trToDispatch.getMeta(pmHistoryPluginKey)) {
+                // bodiedSyncBlock deletion is expected to be permanent (cannot be undo)
+                // For a normal delete (not triggered by undo), remove it from history so that it cannot be undone
+                trToDispatch.setMeta('addToHistory', false);
+              }
+              (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(trToDispatch);
+              _context2.prev = 9;
               if (this.dataProvider) {
-                _context2.next = 10;
+                _context2.next = 12;
                 break;
               }
               throw new Error('Data provider not set');
-            case 10:
+            case 12:
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, true);
               });
-              _context2.next = 13;
+              _context2.next = 15;
               return this.dataProvider.deleteNodesData(syncBlockIds.map(function (attrs) {
                 return attrs.resourceId;
               }));
-            case 13:
+            case 15:
               results = _context2.sent;
               if (results.every(function (result) {
                 return result.success;
@@ -331,11 +338,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                 });
               }
               syncBlockIds.forEach(callback);
-              _context2.next = 23;
+              _context2.next = 25;
               break;
-            case 18:
-              _context2.prev = 18;
-              _context2.t0 = _context2["catch"](7);
+            case 20:
+              _context2.prev = 20;
+              _context2.t0 = _context2["catch"](9);
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, false);
               });
@@ -343,13 +350,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
               (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, deleteErrorPayload(_context2.t0.message));
-            case 23:
+            case 25:
               this.confirmationTransaction = undefined;
-            case 24:
+            case 26:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[7, 18]]);
+        }, _callee2, this, [[9, 20]]);
       }));
       function deleteSyncBlocksWithConfirmation(_x, _x2) {
         return _deleteSyncBlocksWithConfirmation.apply(this, arguments);

package/package.json

@@ -77,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.11.0",
+	"version": "2.11.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",