@atlaskit/editor-synced-block-provider 3.31.1 → 3.31.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.31.2
+
+### Patch Changes
+
+- [`432dbdcd07917`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/432dbdcd07917) -
+  EDITOR-5500 add hasUnsavedBodiedSyncBlocks state to synced block plugin to allow confluence to
+  check whether changes have been saved yet before leaving the page
+
 ## 3.31.1
 
 ### Patch Changes

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

@@ -10,7 +10,9 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _isEqual = _interopRequireDefault(require("lodash/isEqual"));
 var _monitoring = require("@atlaskit/editor-common/monitoring");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
 var _experienceTracking = require("../utils/experienceTracking");
@@ -26,6 +28,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
   function SourceSyncBlockStoreManager(dataProvider) {
     var _this = this;
     (0, _classCallCheck2.default)(this, SourceSyncBlockStoreManager);
+    (0, _defineProperty2.default)(this, "hasReceivedContentChange", false);
     (0, _defineProperty2.default)(this, "setPendingDeletion", function (Ids, value) {
       var syncBlock = _this.syncBlockCache.get(Ids.resourceId);
       if (syncBlock) {
@@ -69,6 +72,12 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
           throw new Error('Local ID or resource ID is not set');
         }
         var syncBlockData = (0, _utils.convertSyncBlockPMNodeToSyncBlockData)(syncBlockNode);
+        if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_5')) {
+          var cachedBlock = this.syncBlockCache.get(resourceId);
+          if (cachedBlock && !(0, _isEqual.default)(syncBlockData.content, cachedBlock.content)) {
+            this.hasReceivedContentChange = true;
+          }
+        }
         this.syncBlockCache.set(resourceId, _objectSpread(_objectSpread({}, syncBlockData), {}, {
           isDirty: true
         }));
@@ -197,6 +206,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
       }
       return flush;
     }())
+  }, {
+    key: "hasUnsavedChanges",
+    value: function hasUnsavedChanges() {
+      return this.hasReceivedContentChange && Array.from(this.syncBlockCache.values()).some(function (syncBlockData) {
+        return syncBlockData.isDirty;
+      });
+    }
   }, {
     key: "isPendingCreation",
     value: function isPendingCreation(resourceId) {

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

@@ -1,5 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import isEqual from 'lodash/isEqual';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload } from '../utils/errorHandling';
 import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience, getFetchSourceInfoExperience } from '../utils/experienceTracking';
@@ -11,6 +13,7 @@ import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
 // Ensures consistency between local and remote state, and can be used in both editor and renderer contexts.
 export class SourceSyncBlockStoreManager {
   constructor(dataProvider) {
+    _defineProperty(this, "hasReceivedContentChange", false);
     _defineProperty(this, "setPendingDeletion", (Ids, value) => {
       const syncBlock = this.syncBlockCache.get(Ids.resourceId);
       if (syncBlock) {
@@ -49,6 +52,12 @@ export class SourceSyncBlockStoreManager {
         throw new Error('Local ID or resource ID is not set');
       }
       const syncBlockData = convertSyncBlockPMNodeToSyncBlockData(syncBlockNode);
+      if (fg('platform_synced_block_patch_5')) {
+        const cachedBlock = this.syncBlockCache.get(resourceId);
+        if (cachedBlock && !isEqual(syncBlockData.content, cachedBlock.content)) {
+          this.hasReceivedContentChange = true;
+        }
+      }
       this.syncBlockCache.set(resourceId, {
         ...syncBlockData,
         isDirty: true
@@ -146,6 +155,9 @@ export class SourceSyncBlockStoreManager {
       return false;
     }
   }
+  hasUnsavedChanges() {
+    return this.hasReceivedContentChange && Array.from(this.syncBlockCache.values()).some(syncBlockData => syncBlockData.isDirty);
+  }
   isPendingCreation(resourceId) {
     return this.creationCompletionCallbacks.has(resourceId);
   }

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

@@ -5,7 +5,9 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 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 isEqual from 'lodash/isEqual';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload } from '../utils/errorHandling';
 import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience, getFetchSourceInfoExperience } from '../utils/experienceTracking';
@@ -19,6 +21,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
   function SourceSyncBlockStoreManager(dataProvider) {
     var _this = this;
     _classCallCheck(this, SourceSyncBlockStoreManager);
+    _defineProperty(this, "hasReceivedContentChange", false);
     _defineProperty(this, "setPendingDeletion", function (Ids, value) {
       var syncBlock = _this.syncBlockCache.get(Ids.resourceId);
       if (syncBlock) {
@@ -62,6 +65,12 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           throw new Error('Local ID or resource ID is not set');
         }
         var syncBlockData = convertSyncBlockPMNodeToSyncBlockData(syncBlockNode);
+        if (fg('platform_synced_block_patch_5')) {
+          var cachedBlock = this.syncBlockCache.get(resourceId);
+          if (cachedBlock && !isEqual(syncBlockData.content, cachedBlock.content)) {
+            this.hasReceivedContentChange = true;
+          }
+        }
         this.syncBlockCache.set(resourceId, _objectSpread(_objectSpread({}, syncBlockData), {}, {
           isDirty: true
         }));
@@ -190,6 +199,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
       }
       return flush;
     }())
+  }, {
+    key: "hasUnsavedChanges",
+    value: function hasUnsavedChanges() {
+      return this.hasReceivedContentChange && Array.from(this.syncBlockCache.values()).some(function (syncBlockData) {
+        return syncBlockData.isDirty;
+      });
+    }
   }, {
     key: "isPendingCreation",
     value: function isPendingCreation(resourceId) {

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

@@ -10,6 +10,7 @@ export declare class SourceSyncBlockStoreManager {
     private dataProvider?;
     private fireAnalyticsEvent?;
     private syncBlockCache;
+    private hasReceivedContentChange;
     private confirmationCallback?;
     private deletionRetryInfo?;
     private creationCompletionCallbacks;
@@ -31,6 +32,7 @@ export declare class SourceSyncBlockStoreManager {
      * @returns true if saving all nodes successfully, false if fail to save some/all nodes
      */
     flush(): Promise<boolean>;
+    hasUnsavedChanges(): boolean;
     isPendingCreation(resourceId: ResourceId): boolean;
     /**
      *  Fires callback to insert node (if creation is successful) and clears pending creation data

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

@@ -10,6 +10,7 @@ export declare class SourceSyncBlockStoreManager {
     private dataProvider?;
     private fireAnalyticsEvent?;
     private syncBlockCache;
+    private hasReceivedContentChange;
     private confirmationCallback?;
     private deletionRetryInfo?;
     private creationCompletionCallbacks;
@@ -31,6 +32,7 @@ export declare class SourceSyncBlockStoreManager {
      * @returns true if saving all nodes successfully, false if fail to save some/all nodes
      */
     flush(): Promise<boolean>;
+    hasUnsavedChanges(): boolean;
     isPendingCreation(resourceId: ResourceId): boolean;
     /**
      *  Fires callback to insert node (if creation is successful) and clears pending creation data

package/package.json

@@ -38,7 +38,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.20.0",
+		"@atlaskit/editor-common": "^111.21.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -81,7 +81,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.31.1",
+	"version": "3.31.2",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",