@atlaskit/editor-synced-block-provider 2.11.2 → 2.11.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.11.3
+
+### Patch Changes
+
+- [`48a3dd84c602b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/48a3dd84c602b) -
+  [EDITOR-3394] Decouple editorView from source manager
+- Updated dependencies
+
 ## 2.11.2
 
 ### Patch Changes

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

@@ -12,10 +12,8 @@ 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 _utils2 = require("../utils/utils");
+var _utils = 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.
@@ -59,7 +57,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         if (!localId || !resourceId) {
           throw new Error('Local ID or resource ID is not set');
         }
-        var syncBlockData = (0, _utils2.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode);
+        var syncBlockData = (0, _utils.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode);
         this.syncBlockCache.set(resourceId, syncBlockData);
         return true;
       } catch (error) {
@@ -155,11 +153,6 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
       }
       return flush;
     }())
-  }, {
-    key: "setEditorView",
-    value: function setEditorView(editorView) {
-      this.editorView = editorView;
-    }
   }, {
     key: "registerPendingCreation",
     value: function registerPendingCreation(resourceId) {
@@ -247,7 +240,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         }
         var resourceId = attrs.resourceId,
           blockInstanceId = attrs.localId;
-        this.dataProvider.writeNodesData([(0, _utils2.createBodiedSyncBlockNode)(blockInstanceId, resourceId)], [{
+        this.dataProvider.writeNodesData([(0, _utils.createBodiedSyncBlockNode)(blockInstanceId, resourceId)], [{
           content: [],
           blockInstanceId: blockInstanceId,
           resourceId: resourceId
@@ -285,47 +278,40 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
   }, {
     key: "deleteSyncBlocksWithConfirmation",
     value: function () {
-      var _deleteSyncBlocksWithConfirmation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(tr, syncBlockIds) {
+      var _deleteSyncBlocksWithConfirmation = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(syncBlockIds, deleteCallback) {
         var _this5 = this;
-        var confirmed, _this$editorView, trToDispatch, results, callback, _this$fireAnalyticsEv4;
+        var confirmed, 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 = 26;
+                _context2.next = 22;
                 break;
               }
-              this.confirmationTransaction = tr;
-              _context2.next = 4;
+              _context2.next = 3;
               return this.confirmationCallback(syncBlockIds.length);
-            case 4:
+            case 3:
               confirmed = _context2.sent;
               if (!confirmed) {
-                _context2.next = 25;
+                _context2.next = 22;
                 break;
               }
-              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;
+              deleteCallback();
+              _context2.prev = 6;
               if (this.dataProvider) {
-                _context2.next = 12;
+                _context2.next = 9;
                 break;
               }
               throw new Error('Data provider not set');
-            case 12:
+            case 9:
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, true);
               });
-              _context2.next = 15;
+              _context2.next = 12;
               return this.dataProvider.deleteNodesData(syncBlockIds.map(function (attrs) {
                 return attrs.resourceId;
               }));
-            case 15:
+            case 12:
               results = _context2.sent;
               if (results.every(function (result) {
                 return result.success;
@@ -345,11 +331,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 });
               }
               syncBlockIds.forEach(callback);
-              _context2.next = 25;
+              _context2.next = 22;
               break;
-            case 20:
-              _context2.prev = 20;
-              _context2.t0 = _context2["catch"](9);
+            case 17:
+              _context2.prev = 17;
+              _context2.t0 = _context2["catch"](6);
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, false);
               });
@@ -357,38 +343,25 @@ 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 25:
-              this.confirmationTransaction = undefined;
-            case 26:
+            case 22:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[9, 20]]);
+        }, _callee2, this, [[6, 17]]);
       }));
       function deleteSyncBlocksWithConfirmation(_x, _x2) {
         return _deleteSyncBlocksWithConfirmation.apply(this, arguments);
       }
       return deleteSyncBlocksWithConfirmation;
     }()
-  }, {
-    key: "rebaseTransaction",
-    value: function rebaseTransaction(incomingTr, state) {
-      if (!this.confirmationTransaction) {
-        return;
-      }
-      this.confirmationTransaction = (0, _rebaseTransaction2.rebaseTransaction)(this.confirmationTransaction, incomingTr, state);
-    }
   }, {
     key: "destroy",
     value: function destroy() {
       this.syncBlockCache.clear();
       this.confirmationCallback = undefined;
-      this.confirmationTransaction = undefined;
       this.pendingResourceId = undefined;
       this.creationCallback = undefined;
       this.dataProvider = undefined;
-      this.editorView = undefined;
-      this.fireAnalyticsEvent = undefined;
     }
   }]);
 }();

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

@@ -2,8 +2,6 @@ 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';
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
@@ -103,9 +101,6 @@ export class SourceSyncBlockStoreManager {
       return false;
     }
   }
-  setEditorView(editorView) {
-    this.editorView = editorView;
-  }
   registerPendingCreation(resourceId) {
     this.pendingResourceId = resourceId;
   }
@@ -212,19 +207,11 @@ export class SourceSyncBlockStoreManager {
       (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 ? void 0 : _this$fireAnalyticsEv6.call(this, createErrorPayload(error.message));
     }
   }
-  async deleteSyncBlocksWithConfirmation(tr, syncBlockIds) {
+  async deleteSyncBlocksWithConfirmation(syncBlockIds, deleteCallback) {
     if (this.confirmationCallback) {
-      this.confirmationTransaction = tr;
       const confirmed = await this.confirmationCallback(syncBlockIds.length);
       if (confirmed) {
-        var _this$editorView;
-        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);
+        deleteCallback();
         try {
           if (!this.dataProvider) {
             throw new Error('Data provider not set');
@@ -257,23 +244,13 @@ export class SourceSyncBlockStoreManager {
           (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 ? void 0 : _this$fireAnalyticsEv8.call(this, deleteErrorPayload(error.message));
         }
       }
-      this.confirmationTransaction = undefined;
-    }
-  }
-  rebaseTransaction(incomingTr, state) {
-    if (!this.confirmationTransaction) {
-      return;
     }
-    this.confirmationTransaction = rebaseTransaction(this.confirmationTransaction, incomingTr, state);
   }
   destroy() {
     this.syncBlockCache.clear();
     this.confirmationCallback = undefined;
-    this.confirmationTransaction = undefined;
     this.pendingResourceId = undefined;
     this.creationCallback = undefined;
     this.dataProvider = undefined;
-    this.editorView = undefined;
-    this.fireAnalyticsEvent = undefined;
   }
 }

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

@@ -6,8 +6,6 @@ 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';
 // A store manager responsible for the lifecycle and state management of source sync blocks in an editor instance.
@@ -148,11 +146,6 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
       }
       return flush;
     }())
-  }, {
-    key: "setEditorView",
-    value: function setEditorView(editorView) {
-      this.editorView = editorView;
-    }
   }, {
     key: "registerPendingCreation",
     value: function registerPendingCreation(resourceId) {
@@ -278,47 +271,40 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "deleteSyncBlocksWithConfirmation",
     value: function () {
-      var _deleteSyncBlocksWithConfirmation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(tr, syncBlockIds) {
+      var _deleteSyncBlocksWithConfirmation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(syncBlockIds, deleteCallback) {
         var _this5 = this;
-        var confirmed, _this$editorView, trToDispatch, results, callback, _this$fireAnalyticsEv4;
+        var confirmed, results, callback, _this$fireAnalyticsEv4;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
               if (!this.confirmationCallback) {
-                _context2.next = 26;
+                _context2.next = 22;
                 break;
               }
-              this.confirmationTransaction = tr;
-              _context2.next = 4;
+              _context2.next = 3;
               return this.confirmationCallback(syncBlockIds.length);
-            case 4:
+            case 3:
               confirmed = _context2.sent;
               if (!confirmed) {
-                _context2.next = 25;
+                _context2.next = 22;
                 break;
               }
-              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;
+              deleteCallback();
+              _context2.prev = 6;
               if (this.dataProvider) {
-                _context2.next = 12;
+                _context2.next = 9;
                 break;
               }
               throw new Error('Data provider not set');
-            case 12:
+            case 9:
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, true);
               });
-              _context2.next = 15;
+              _context2.next = 12;
               return this.dataProvider.deleteNodesData(syncBlockIds.map(function (attrs) {
                 return attrs.resourceId;
               }));
-            case 15:
+            case 12:
               results = _context2.sent;
               if (results.every(function (result) {
                 return result.success;
@@ -338,11 +324,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
                 });
               }
               syncBlockIds.forEach(callback);
-              _context2.next = 25;
+              _context2.next = 22;
               break;
-            case 20:
-              _context2.prev = 20;
-              _context2.t0 = _context2["catch"](9);
+            case 17:
+              _context2.prev = 17;
+              _context2.t0 = _context2["catch"](6);
               syncBlockIds.forEach(function (Ids) {
                 _this5.setPendingDeletion(Ids, false);
               });
@@ -350,38 +336,25 @@ 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 25:
-              this.confirmationTransaction = undefined;
-            case 26:
+            case 22:
             case "end":
               return _context2.stop();
           }
-        }, _callee2, this, [[9, 20]]);
+        }, _callee2, this, [[6, 17]]);
       }));
       function deleteSyncBlocksWithConfirmation(_x, _x2) {
         return _deleteSyncBlocksWithConfirmation.apply(this, arguments);
       }
       return deleteSyncBlocksWithConfirmation;
     }()
-  }, {
-    key: "rebaseTransaction",
-    value: function rebaseTransaction(incomingTr, state) {
-      if (!this.confirmationTransaction) {
-        return;
-      }
-      this.confirmationTransaction = _rebaseTransaction(this.confirmationTransaction, incomingTr, state);
-    }
   }, {
     key: "destroy",
     value: function destroy() {
       this.syncBlockCache.clear();
       this.confirmationCallback = undefined;
-      this.confirmationTransaction = undefined;
       this.pendingResourceId = undefined;
       this.creationCallback = undefined;
       this.dataProvider = undefined;
-      this.editorView = undefined;
-      this.fireAnalyticsEvent = undefined;
     }
   }]);
 }();

package/dist/types/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -1,18 +1,14 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { ResourceId, SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
 export type CreationCallback = () => void;
 export declare class SourceSyncBlockStoreManager {
     private dataProvider?;
-    private editorView?;
     private fireAnalyticsEvent?;
     private syncBlockCache;
     private confirmationCallback?;
-    private confirmationTransaction?;
     private pendingResourceId?;
     private creationCallback?;
     constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void);
@@ -28,7 +24,6 @@ export declare class SourceSyncBlockStoreManager {
      * @returns true if saving all nodes successfully, false if fail to save some/all nodes
      */
     flush(): Promise<boolean>;
-    setEditorView(editorView: EditorView | undefined): void;
     registerPendingCreation(resourceId: ResourceId): void;
     /**
      * Register callback function (which inserts node, handles focus etc) to be used later when creation to backend succeed
@@ -56,7 +51,6 @@ export declare class SourceSyncBlockStoreManager {
      */
     createBodiedSyncBlockNode(attrs: SyncBlockAttrs): void;
     private setPendingDeletion;
-    deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
-    rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    deleteSyncBlocksWithConfirmation(syncBlockIds: SyncBlockAttrs[], deleteCallback: () => void): Promise<void>;
     destroy(): void;
 }

package/dist/types-ts4.5/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -1,18 +1,14 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
-import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { ResourceId, SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
 export type CreationCallback = () => void;
 export declare class SourceSyncBlockStoreManager {
     private dataProvider?;
-    private editorView?;
     private fireAnalyticsEvent?;
     private syncBlockCache;
     private confirmationCallback?;
-    private confirmationTransaction?;
     private pendingResourceId?;
     private creationCallback?;
     constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void);
@@ -28,7 +24,6 @@ export declare class SourceSyncBlockStoreManager {
      * @returns true if saving all nodes successfully, false if fail to save some/all nodes
      */
     flush(): Promise<boolean>;
-    setEditorView(editorView: EditorView | undefined): void;
     registerPendingCreation(resourceId: ResourceId): void;
     /**
      * Register callback function (which inserts node, handles focus etc) to be used later when creation to backend succeed
@@ -56,7 +51,6 @@ export declare class SourceSyncBlockStoreManager {
      */
     createBodiedSyncBlockNode(attrs: SyncBlockAttrs): void;
     private setPendingDeletion;
-    deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
-    rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    deleteSyncBlocksWithConfirmation(syncBlockIds: SyncBlockAttrs[], deleteCallback: () => void): Promise<void>;
     destroy(): void;
 }

package/package.json

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