@atlaskit/editor-synced-block-provider 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-synced-block-provider
 
+## 0.4.0
+
+### Minor Changes
+
+- [`acb8231bc9e0c`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/acb8231bc9e0c) -
+  EDITOR-1779 - "rebase" the transaction to reflect the latest document state
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/cjs/common/rebase-transaction.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.rebaseTransaction = void 0;
+var _transform = require("@atlaskit/editor-prosemirror/transform");
+/**
+ * Rebase `currentTr` over `incomingTr` based on the provided `state`.
+ * This function adjusts the steps in `currentTr` to account for the changes made by `incomingTr`.
+ *
+ * @param currentTr - The transaction to be rebased.
+ * @param incomingTr - The transaction that has already been applied to the state.
+ * @param state - The editor state after applying `incomingTr`.
+ * @returns A new transaction that represents `currentTr` rebased over `incomingTr`.
+ */
+var rebaseTransaction = exports.rebaseTransaction = function rebaseTransaction(currentTr, incomingTr, state) {
+  if (!incomingTr.docChanged) {
+    return currentTr;
+  }
+  var currentMapping = new _transform.Mapping(incomingTr.mapping.maps);
+  var rebasedTransaction = state.tr;
+  currentTr.steps.forEach(function (step) {
+    var mappedStep = step.map(currentMapping);
+    if (mappedStep) {
+      rebasedTransaction.step(mappedStep);
+      currentMapping.appendMap(mappedStep.getMap());
+    }
+  });
+  return rebasedTransaction;
+};

package/dist/cjs/common/syncBlockStoreManager.js

@@ -10,6 +10,7 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _uuid = _interopRequireDefault(require("uuid"));
+var _rebaseTransaction2 = require("./rebase-transaction");
 // Do this typedef to make it clear that
 // this is a local identifier for a resource for local use
 // A store manager responsible for the lifecycle and state management of sync blocks in an editor instance.
@@ -88,23 +89,24 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
           while (1) switch (_context.prev = _context.next) {
             case 0:
               if (!this.confirmationCallback) {
-                _context.next = 5;
+                _context.next = 7;
                 break;
               }
-              _context.next = 3;
+              this.confirmationTransaction = tr;
+              _context.next = 4;
               return this.confirmationCallback();
-            case 3:
+            case 4:
               confirmed = _context.sent;
               if (confirmed) {
-                // TODO: EDITOR-1779 - "rebase" the transaction to reflect the latest document state
-                (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(tr.setMeta('isConfirmedSyncBlockDeletion', true));
+                (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true));
                 // Need to update the BE on deletion
                 syncBlockIds.forEach(function (_ref) {
                   var resourceId = _ref.resourceId;
                   return _this2.syncBlocks.delete(resourceId);
                 });
               }
-            case 5:
+              this.confirmationTransaction = undefined;
+            case 7:
             case "end":
               return _context.stop();
           }
@@ -115,5 +117,13 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
       }
       return deleteSyncBlocksWithConfirmation;
     }()
+  }, {
+    key: "rebaseTransaction",
+    value: function rebaseTransaction(incomingTr, state) {
+      if (!this.confirmationTransaction) {
+        return;
+      }
+      this.confirmationTransaction = (0, _rebaseTransaction2.rebaseTransaction)(this.confirmationTransaction, incomingTr, state);
+    }
   }]);
 }();

package/dist/cjs/index.js

@@ -57,6 +57,12 @@ Object.defineProperty(exports, "inMemoryWriteProvider", {
     return _inMemory.inMemoryWriteProvider;
   }
 });
+Object.defineProperty(exports, "rebaseTransaction", {
+  enumerable: true,
+  get: function get() {
+    return _rebaseTransaction.rebaseTransaction;
+  }
+});
 Object.defineProperty(exports, "useFetchDocNode", {
   enumerable: true,
   get: function get() {
@@ -81,4 +87,5 @@ var _inMemory = require("./providers/inMemory");
 var _schema = require("./common/schema");
 var _confluenceContentAPI = require("./providers/confluenceContentAPI");
 var _ari = require("./utils/ari");
-var _utils = require("./utils/utils");
+var _utils = require("./utils/utils");
+var _rebaseTransaction = require("./common/rebase-transaction");

package/dist/es2019/common/rebase-transaction.js

@@ -0,0 +1,26 @@
+import { Mapping } from '@atlaskit/editor-prosemirror/transform';
+
+/**
+ * Rebase `currentTr` over `incomingTr` based on the provided `state`.
+ * This function adjusts the steps in `currentTr` to account for the changes made by `incomingTr`.
+ *
+ * @param currentTr - The transaction to be rebased.
+ * @param incomingTr - The transaction that has already been applied to the state.
+ * @param state - The editor state after applying `incomingTr`.
+ * @returns A new transaction that represents `currentTr` rebased over `incomingTr`.
+ */
+export const rebaseTransaction = (currentTr, incomingTr, state) => {
+  if (!incomingTr.docChanged) {
+    return currentTr;
+  }
+  const currentMapping = new Mapping(incomingTr.mapping.maps);
+  const rebasedTransaction = state.tr;
+  currentTr.steps.forEach(step => {
+    const mappedStep = step.map(currentMapping);
+    if (mappedStep) {
+      rebasedTransaction.step(mappedStep);
+      currentMapping.appendMap(mappedStep.getMap());
+    }
+  });
+  return rebasedTransaction;
+};

package/dist/es2019/common/syncBlockStoreManager.js

@@ -1,4 +1,5 @@
 import uuid from 'uuid';
+import { rebaseTransaction } from './rebase-transaction';
 
 // Do this typedef to make it clear that
 // this is a local identifier for a resource for local use
@@ -60,16 +61,23 @@ export class SyncBlockStoreManager {
   }
   async deleteSyncBlocksWithConfirmation(tr, syncBlockIds) {
     if (this.confirmationCallback) {
+      this.confirmationTransaction = tr;
       const confirmed = await this.confirmationCallback();
       if (confirmed) {
         var _this$editorView;
-        // TODO: EDITOR-1779 - "rebase" the transaction to reflect the latest document state
-        (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.dispatch(tr.setMeta('isConfirmedSyncBlockDeletion', true));
+        (_this$editorView = this.editorView) === null || _this$editorView === void 0 ? void 0 : _this$editorView.dispatch(this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true));
         // Need to update the BE on deletion
         syncBlockIds.forEach(({
           resourceId
         }) => this.syncBlocks.delete(resourceId));
       }
+      this.confirmationTransaction = undefined;
     }
   }
+  rebaseTransaction(incomingTr, state) {
+    if (!this.confirmationTransaction) {
+      return;
+    }
+    this.confirmationTransaction = rebaseTransaction(this.confirmationTransaction, incomingTr, state);
+  }
 }

package/dist/es2019/index.js

@@ -6,4 +6,5 @@ export { inMemoryFetchProvider, inMemoryWriteProvider } from './providers/inMemo
 export { getDefaultSyncBlockSchema } from './common/schema';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders } from './providers/confluenceContentAPI';
 export { getConfluencePageAri } from './utils/ari';
-export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { rebaseTransaction } from './common/rebase-transaction';

package/dist/esm/common/rebase-transaction.js

@@ -0,0 +1,26 @@
+import { Mapping } from '@atlaskit/editor-prosemirror/transform';
+
+/**
+ * Rebase `currentTr` over `incomingTr` based on the provided `state`.
+ * This function adjusts the steps in `currentTr` to account for the changes made by `incomingTr`.
+ *
+ * @param currentTr - The transaction to be rebased.
+ * @param incomingTr - The transaction that has already been applied to the state.
+ * @param state - The editor state after applying `incomingTr`.
+ * @returns A new transaction that represents `currentTr` rebased over `incomingTr`.
+ */
+export var rebaseTransaction = function rebaseTransaction(currentTr, incomingTr, state) {
+  if (!incomingTr.docChanged) {
+    return currentTr;
+  }
+  var currentMapping = new Mapping(incomingTr.mapping.maps);
+  var rebasedTransaction = state.tr;
+  currentTr.steps.forEach(function (step) {
+    var mappedStep = step.map(currentMapping);
+    if (mappedStep) {
+      rebasedTransaction.step(mappedStep);
+      currentMapping.appendMap(mappedStep.getMap());
+    }
+  });
+  return rebasedTransaction;
+};

package/dist/esm/common/syncBlockStoreManager.js

@@ -3,6 +3,7 @@ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import uuid from 'uuid';
+import { rebaseTransaction as _rebaseTransaction } from './rebase-transaction';
 
 // Do this typedef to make it clear that
 // this is a local identifier for a resource for local use
@@ -83,23 +84,24 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               if (!this.confirmationCallback) {
-                _context.next = 5;
+                _context.next = 7;
                 break;
               }
-              _context.next = 3;
+              this.confirmationTransaction = tr;
+              _context.next = 4;
               return this.confirmationCallback();
-            case 3:
+            case 4:
               confirmed = _context.sent;
               if (confirmed) {
-                // TODO: EDITOR-1779 - "rebase" the transaction to reflect the latest document state
-                (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(tr.setMeta('isConfirmedSyncBlockDeletion', true));
+                (_this$editorView = this.editorView) === null || _this$editorView === void 0 || _this$editorView.dispatch(this.confirmationTransaction.setMeta('isConfirmedSyncBlockDeletion', true));
                 // Need to update the BE on deletion
                 syncBlockIds.forEach(function (_ref) {
                   var resourceId = _ref.resourceId;
                   return _this2.syncBlocks.delete(resourceId);
                 });
               }
-            case 5:
+              this.confirmationTransaction = undefined;
+            case 7:
             case "end":
               return _context.stop();
           }
@@ -110,5 +112,13 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
       }
       return deleteSyncBlocksWithConfirmation;
     }()
+  }, {
+    key: "rebaseTransaction",
+    value: function rebaseTransaction(incomingTr, state) {
+      if (!this.confirmationTransaction) {
+        return;
+      }
+      this.confirmationTransaction = _rebaseTransaction(this.confirmationTransaction, incomingTr, state);
+    }
   }]);
 }();

package/dist/esm/index.js

@@ -6,4 +6,5 @@ export { inMemoryFetchProvider, inMemoryWriteProvider } from './providers/inMemo
 export { getDefaultSyncBlockSchema } from './common/schema';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders } from './providers/confluenceContentAPI';
 export { getConfluencePageAri } from './utils/ari';
-export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { rebaseTransaction } from './common/rebase-transaction';

package/dist/types/common/rebase-transaction.d.ts

@@ -0,0 +1,11 @@
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Rebase `currentTr` over `incomingTr` based on the provided `state`.
+ * This function adjusts the steps in `currentTr` to account for the changes made by `incomingTr`.
+ *
+ * @param currentTr - The transaction to be rebased.
+ * @param incomingTr - The transaction that has already been applied to the state.
+ * @param state - The editor state after applying `incomingTr`.
+ * @returns A new transaction that represents `currentTr` rebased over `incomingTr`.
+ */
+export declare const rebaseTransaction: (currentTr: Transaction, incomingTr: Transaction, state: EditorState) => Transaction;

package/dist/types/common/syncBlockStoreManager.d.ts

@@ -1,6 +1,6 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { SyncBlockAttrs, SyncBlockDataProvider, SyncBlockNode } from './types';
 export interface SyncBlock {
@@ -18,6 +18,7 @@ export declare class SyncBlockStoreManager {
     private confirmationCallback?;
     private editorView?;
     private dataProvider?;
+    private confirmationTransaction?;
     constructor(dataProvider?: SyncBlockDataProvider);
     setEditorView(editorView: EditorView | undefined): void;
     isSourceBlock(node: PMNode): boolean;
@@ -25,5 +26,6 @@ export declare class SyncBlockStoreManager {
     requireConfirmationBeforeDelete(): boolean;
     createSyncBlockNode(): SyncBlockNode;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
+    rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
 }
 export {};

package/dist/types/index.d.ts

@@ -6,3 +6,4 @@ export { getDefaultSyncBlockSchema } from './common/schema';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluenceContentAPI';
 export { getConfluencePageAri } from './utils/ari';
 export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { rebaseTransaction } from './common/rebase-transaction';

package/dist/types-ts4.5/common/rebase-transaction.d.ts

@@ -0,0 +1,11 @@
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
+/**
+ * Rebase `currentTr` over `incomingTr` based on the provided `state`.
+ * This function adjusts the steps in `currentTr` to account for the changes made by `incomingTr`.
+ *
+ * @param currentTr - The transaction to be rebased.
+ * @param incomingTr - The transaction that has already been applied to the state.
+ * @param state - The editor state after applying `incomingTr`.
+ * @returns A new transaction that represents `currentTr` rebased over `incomingTr`.
+ */
+export declare const rebaseTransaction: (currentTr: Transaction, incomingTr: Transaction, state: EditorState) => Transaction;

package/dist/types-ts4.5/common/syncBlockStoreManager.d.ts

@@ -1,6 +1,6 @@
 import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { Transaction } from '@atlaskit/editor-prosemirror/state';
+import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { SyncBlockAttrs, SyncBlockDataProvider, SyncBlockNode } from './types';
 export interface SyncBlock {
@@ -18,6 +18,7 @@ export declare class SyncBlockStoreManager {
     private confirmationCallback?;
     private editorView?;
     private dataProvider?;
+    private confirmationTransaction?;
     constructor(dataProvider?: SyncBlockDataProvider);
     setEditorView(editorView: EditorView | undefined): void;
     isSourceBlock(node: PMNode): boolean;
@@ -25,5 +26,6 @@ export declare class SyncBlockStoreManager {
     requireConfirmationBeforeDelete(): boolean;
     createSyncBlockNode(): SyncBlockNode;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
+    rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
 }
 export {};

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

@@ -6,3 +6,4 @@ export { getDefaultSyncBlockSchema } from './common/schema';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluenceContentAPI';
 export { getConfluencePageAri } from './utils/ari';
 export { convertSyncBlockPMNodeToSyncBlockData, generateSyncBlockSourceUrl } from './utils/utils';
+export { rebaseTransaction } from './common/rebase-transaction';

package/package.json

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