@atlaskit/editor-synced-block-provider 2.13.1 → 2.14.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.14.0
+
+### Minor Changes
+
+- [`8f3a22c66ae60`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8f3a22c66ae60) -
+  Update to read from ssr cache
+
 ## 2.13.1
 
 ### Patch Changes

package/dist/cjs/hooks/useFetchSyncBlockData.js

@@ -14,7 +14,15 @@ var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
 var _utils = require("../utils/utils");
 var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId, fireAnalyticsEvent) {
-  var _useState = (0, _react.useState)(null),
+  var _useState = (0, _react.useState)(function () {
+      if (resourceId) {
+        var _manager$referenceMan;
+        var _ref = (manager === null || manager === void 0 || (_manager$referenceMan = manager.referenceManager) === null || _manager$referenceMan === void 0 ? void 0 : _manager$referenceMan.getInitialSyncBlockData(resourceId)) || {},
+          data = _ref.data;
+        return data || null;
+      }
+      return null;
+    }),
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),
     syncBlockInstance = _useState2[0],
     setSyncBlockInstance = _useState2[1];

package/dist/cjs/providers/syncBlockProvider.js

@@ -73,7 +73,7 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
   }, {
     key: "nodeDataKey",
     value: function nodeDataKey(node) {
-      return node.attrs.localId;
+      return node.attrs.resourceId;
     }
 
     /**
@@ -298,8 +298,13 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     }
   }]);
 }(_types2.SyncBlockDataProvider);
-var useMemoizedSyncedBlockProvider = exports.useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions) {
+var useMemoizedSyncedBlockProvider = exports.useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions, getSSRData) {
   return (0, _react.useMemo)(function () {
-    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
-  }, [fetchProvider, writeProvider, sourceId, providerOptions]);
+    var syncBlockProvider = new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
+    var ssrData = getSSRData ? getSSRData() : undefined;
+    if (ssrData) {
+      syncBlockProvider.setSSRData(ssrData);
+    }
+    return syncBlockProvider;
+  }, [fetchProvider, writeProvider, sourceId, providerOptions, getSSRData]);
 };

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

@@ -52,6 +52,13 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     value: function updateFireAnalyticsEvent(fireAnalyticsEvent) {
       this.fireAnalyticsEvent = fireAnalyticsEvent;
     }
+  }, {
+    key: "getInitialSyncBlockData",
+    value: function getInitialSyncBlockData(resourceId) {
+      var _this$dataProvider;
+      var syncBlockNode = (0, _utils.createSyncBlockNode)('', resourceId);
+      return this.getFromCache(resourceId) || ((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 || (_this$dataProvider = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.data);
+    }
 
     /**
      * Refreshes the subscriptions for all sync blocks.
@@ -315,17 +322,20 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "subscribeToSyncBlock",
     value: function subscribeToSyncBlock(resourceId, localId, callback) {
-      var _this3 = this;
+      var _this$dataProvider2,
+        _this3 = this;
       // add to subscriptions map
       var resourceSubscriptions = this.subscriptions.get(resourceId) || {};
       this.subscriptions.set(resourceId, _objectSpread(_objectSpread({}, resourceSubscriptions), {}, (0, _defineProperty2.default)({}, localId, callback)));
+      var syncBlockNode = (0, _utils.createSyncBlockNode)(localId, resourceId);
 
       // call the callback immediately if we have cached data
-      var cachedData = this.getFromCache(resourceId);
+      // prefer cache from store manager first, should update data provider to use the same cache
+      var cachedData = this.getFromCache(resourceId) || ((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 || (_this$dataProvider2 = _this$dataProvider2.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider2 === void 0 ? void 0 : _this$dataProvider2.data);
       if (cachedData) {
         callback(cachedData);
       } else {
-        this.fetchSyncBlocksData([(0, _utils.createSyncBlockNode)(localId, resourceId)]).catch(function (error) {
+        this.fetchSyncBlocksData([syncBlockNode]).catch(function (error) {
           var _this3$fireAnalyticsE;
           (0, _monitoring.logException)(error, {
             location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'

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

@@ -117,7 +117,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
             case 10:
               writeResults = _context.sent;
               if (!writeResults.every(function (result) {
-                return !result.error;
+                return result.resourceId !== undefined;
               })) {
                 _context.next = 15;
                 break;
@@ -125,7 +125,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               return _context.abrupt("return", true);
             case 15:
               writeResults.filter(function (result) {
-                return result.error;
+                return result.resourceId === undefined;
               }).forEach(function (result) {
                 var _this2$fireAnalyticsE;
                 (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, (0, _errorHandling.updateErrorPayload)(result.error || 'Failed to write data'));

package/dist/es2019/hooks/useFetchSyncBlockData.js

@@ -4,7 +4,16 @@ import { SyncBlockError } from '../common/types';
 import { fetchErrorPayload } from '../utils/errorHandling';
 import { createSyncBlockNode } from '../utils/utils';
 export const useFetchSyncBlockData = (manager, resourceId, localId, fireAnalyticsEvent) => {
-  const [syncBlockInstance, setSyncBlockInstance] = useState(null);
+  const [syncBlockInstance, setSyncBlockInstance] = useState(() => {
+    if (resourceId) {
+      var _manager$referenceMan;
+      const {
+        data
+      } = (manager === null || manager === void 0 ? void 0 : (_manager$referenceMan = manager.referenceManager) === null || _manager$referenceMan === void 0 ? void 0 : _manager$referenceMan.getInitialSyncBlockData(resourceId)) || {};
+      return data || null;
+    }
+    return null;
+  });
   const [isLoading, setIsLoading] = useState(true);
   const reloadData = useCallback(async () => {
     if (isLoading) {

package/dist/es2019/providers/syncBlockProvider.js

@@ -46,7 +46,7 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
    * @returns The data key
    */
   nodeDataKey(node) {
-    return node.attrs.localId;
+    return node.attrs.resourceId;
   }
 
   /**
@@ -201,8 +201,13 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
     }
   }
 }
-export const useMemoizedSyncedBlockProvider = (fetchProvider, writeProvider, sourceId, providerOptions) => {
+export const useMemoizedSyncedBlockProvider = (fetchProvider, writeProvider, sourceId, providerOptions, getSSRData) => {
   return useMemo(() => {
-    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
-  }, [fetchProvider, writeProvider, sourceId, providerOptions]);
+    const syncBlockProvider = new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
+    const ssrData = getSSRData ? getSSRData() : undefined;
+    if (ssrData) {
+      syncBlockProvider.setSSRData(ssrData);
+    }
+    return syncBlockProvider;
+  }, [fetchProvider, writeProvider, sourceId, providerOptions, getSSRData]);
 };

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

@@ -31,6 +31,11 @@ export class ReferenceSyncBlockStoreManager {
   updateFireAnalyticsEvent(fireAnalyticsEvent) {
     this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
+  getInitialSyncBlockData(resourceId) {
+    var _this$dataProvider, _this$dataProvider$ge;
+    const syncBlockNode = createSyncBlockNode('', resourceId);
+    return this.getFromCache(resourceId) || ((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : (_this$dataProvider$ge = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider$ge === void 0 ? void 0 : _this$dataProvider$ge.data);
+  }
 
   /**
    * Refreshes the subscriptions for all sync blocks.
@@ -200,19 +205,22 @@ export class ReferenceSyncBlockStoreManager {
     this.providerFactories.delete(resourceId);
   }
   subscribeToSyncBlock(resourceId, localId, callback) {
+    var _this$dataProvider2, _this$dataProvider2$g;
     // add to subscriptions map
     const resourceSubscriptions = this.subscriptions.get(resourceId) || {};
     this.subscriptions.set(resourceId, {
       ...resourceSubscriptions,
       [localId]: callback
     });
+    const syncBlockNode = createSyncBlockNode(localId, resourceId);
 
     // call the callback immediately if we have cached data
-    const cachedData = this.getFromCache(resourceId);
+    // prefer cache from store manager first, should update data provider to use the same cache
+    const cachedData = this.getFromCache(resourceId) || ((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 ? void 0 : (_this$dataProvider2$g = _this$dataProvider2.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider2$g === void 0 ? void 0 : _this$dataProvider2$g.data);
     if (cachedData) {
       callback(cachedData);
     } else {
-      this.fetchSyncBlocksData([createSyncBlockNode(localId, resourceId)]).catch(error => {
+      this.fetchSyncBlocksData([syncBlockNode]).catch(error => {
         var _this$fireAnalyticsEv7;
         logException(error, {
           location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'

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

@@ -83,10 +83,10 @@ export class SourceSyncBlockStoreManager {
         return Promise.resolve(true);
       }
       const writeResults = await this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
-      if (writeResults.every(result => !result.error)) {
+      if (writeResults.every(result => result.resourceId !== undefined)) {
         return true;
       } else {
-        writeResults.filter(result => result.error).forEach(result => {
+        writeResults.filter(result => result.resourceId === undefined).forEach(result => {
           var _this$fireAnalyticsEv2;
           (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 ? void 0 : _this$fireAnalyticsEv2.call(this, updateErrorPayload(result.error || 'Failed to write data'));
         });

package/dist/esm/hooks/useFetchSyncBlockData.js

@@ -7,7 +7,15 @@ import { SyncBlockError } from '../common/types';
 import { fetchErrorPayload } from '../utils/errorHandling';
 import { createSyncBlockNode } from '../utils/utils';
 export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId, fireAnalyticsEvent) {
-  var _useState = useState(null),
+  var _useState = useState(function () {
+      if (resourceId) {
+        var _manager$referenceMan;
+        var _ref = (manager === null || manager === void 0 || (_manager$referenceMan = manager.referenceManager) === null || _manager$referenceMan === void 0 ? void 0 : _manager$referenceMan.getInitialSyncBlockData(resourceId)) || {},
+          data = _ref.data;
+        return data || null;
+      }
+      return null;
+    }),
     _useState2 = _slicedToArray(_useState, 2),
     syncBlockInstance = _useState2[0],
     setSyncBlockInstance = _useState2[1];

package/dist/esm/providers/syncBlockProvider.js

@@ -66,7 +66,7 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
   }, {
     key: "nodeDataKey",
     value: function nodeDataKey(node) {
-      return node.attrs.localId;
+      return node.attrs.resourceId;
     }
 
     /**
@@ -291,8 +291,13 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     }
   }]);
 }(SyncBlockDataProvider);
-export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions) {
+export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions, getSSRData) {
   return useMemo(function () {
-    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
-  }, [fetchProvider, writeProvider, sourceId, providerOptions]);
+    var syncBlockProvider = new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
+    var ssrData = getSSRData ? getSSRData() : undefined;
+    if (ssrData) {
+      syncBlockProvider.setSSRData(ssrData);
+    }
+    return syncBlockProvider;
+  }, [fetchProvider, writeProvider, sourceId, providerOptions, getSSRData]);
 };

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

@@ -46,6 +46,13 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function updateFireAnalyticsEvent(fireAnalyticsEvent) {
       this.fireAnalyticsEvent = fireAnalyticsEvent;
     }
+  }, {
+    key: "getInitialSyncBlockData",
+    value: function getInitialSyncBlockData(resourceId) {
+      var _this$dataProvider;
+      var syncBlockNode = createSyncBlockNode('', resourceId);
+      return this.getFromCache(resourceId) || ((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 || (_this$dataProvider = _this$dataProvider.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.data);
+    }
 
     /**
      * Refreshes the subscriptions for all sync blocks.
@@ -309,17 +316,20 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "subscribeToSyncBlock",
     value: function subscribeToSyncBlock(resourceId, localId, callback) {
-      var _this3 = this;
+      var _this$dataProvider2,
+        _this3 = this;
       // add to subscriptions map
       var resourceSubscriptions = this.subscriptions.get(resourceId) || {};
       this.subscriptions.set(resourceId, _objectSpread(_objectSpread({}, resourceSubscriptions), {}, _defineProperty({}, localId, callback)));
+      var syncBlockNode = createSyncBlockNode(localId, resourceId);
 
       // call the callback immediately if we have cached data
-      var cachedData = this.getFromCache(resourceId);
+      // prefer cache from store manager first, should update data provider to use the same cache
+      var cachedData = this.getFromCache(resourceId) || ((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 || (_this$dataProvider2 = _this$dataProvider2.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider2 === void 0 ? void 0 : _this$dataProvider2.data);
       if (cachedData) {
         callback(cachedData);
       } else {
-        this.fetchSyncBlocksData([createSyncBlockNode(localId, resourceId)]).catch(function (error) {
+        this.fetchSyncBlocksData([syncBlockNode]).catch(function (error) {
           var _this3$fireAnalyticsE;
           logException(error, {
             location: 'editor-synced-block-provider/referenceSyncBlockStoreManager'

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

@@ -110,7 +110,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
             case 10:
               writeResults = _context.sent;
               if (!writeResults.every(function (result) {
-                return !result.error;
+                return result.resourceId !== undefined;
               })) {
                 _context.next = 15;
                 break;
@@ -118,7 +118,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               return _context.abrupt("return", true);
             case 15:
               writeResults.filter(function (result) {
-                return result.error;
+                return result.resourceId === undefined;
               }).forEach(function (result) {
                 var _this2$fireAnalyticsE;
                 (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, updateErrorPayload(result.error || 'Failed to write data'));

package/dist/types/providers/syncBlockProvider.d.ts

@@ -95,4 +95,4 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      */
     retrieveSyncBlockParentInfo(sourceAri: string, sourceProduct: SyncBlockProduct): SyncBlockParentInfo | undefined;
 }
-export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions) => SyncBlockProvider;
+export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions, getSSRData?: () => Record<string, SyncBlockInstance> | undefined) => SyncBlockProvider;

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

@@ -15,6 +15,7 @@ export declare class ReferenceSyncBlockStoreManager {
     constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void);
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
+    getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;
     /**
      * Refreshes the subscriptions for all sync blocks.
      * @returns {Promise<void>}

package/dist/types-ts4.5/providers/syncBlockProvider.d.ts

@@ -95,4 +95,4 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      */
     retrieveSyncBlockParentInfo(sourceAri: string, sourceProduct: SyncBlockProduct): SyncBlockParentInfo | undefined;
 }
-export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions) => SyncBlockProvider;
+export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions, getSSRData?: () => Record<string, SyncBlockInstance> | undefined) => SyncBlockProvider;

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

@@ -15,6 +15,7 @@ export declare class ReferenceSyncBlockStoreManager {
     constructor(dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void);
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
+    getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;
     /**
      * Refreshes the subscriptions for all sync blocks.
      * @returns {Promise<void>}

package/package.json

@@ -6,7 +6,7 @@
 			"category": "Layout and structure"
 		}
 	},
-	"repository": "https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo",
+	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-monorepo",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
 	"module:es2019": "dist/es2019/index.js",
@@ -34,7 +34,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.40.0",
+		"@atlaskit/editor-common": "^110.41.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -77,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.13.1",
+	"version": "2.14.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",