@atlaskit/editor-synced-block-provider 3.29.0 → 3.29.2

package/dist/es2019/providers/syncBlockProvider.js

@@ -5,10 +5,10 @@ import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
 import { fetchJiraWorkItemInfo } from '../clients/jira/sourceInfo';
 import { SyncBlockError } from '../common/types';
-import { SyncBlockDataProvider } from './types';
-export class SyncBlockProvider extends SyncBlockDataProvider {
+import { SyncBlockDataProviderInterface } from './types';
+export class SyncedBlockProvider extends SyncBlockDataProviderInterface {
   /**
-   * Constructor for the SyncBlockProvider
+   * Constructor for the SyncedBlockProvider
    *
    * @param fetchProvider
    * @param writeProvider
@@ -283,7 +283,7 @@ const createSyncedBlockProvider = ({
   fetchProvider,
   writeProvider
 }) => {
-  return new SyncBlockProvider(fetchProvider, writeProvider);
+  return new SyncedBlockProvider(fetchProvider, writeProvider);
 };
 export const useMemoizedSyncedBlockProvider = ({
   fetchProvider,

package/dist/es2019/providers/types.js

@@ -6,4 +6,4 @@ import { NodeDataProvider } from '@atlaskit/node-data-provider';
  * This will be used in both data processing and rendering contexts.
  */
 
-export class SyncBlockDataProvider extends NodeDataProvider {}
+export class SyncBlockDataProviderInterface extends NodeDataProvider {}

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

@@ -10,6 +10,7 @@ import { getFetchExperience, getFetchSourceInfoExperience, getSaveReferenceExper
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { parseResourceId } from '../utils/resourceId';
 import { createSyncBlockNode } from '../utils/utils';
+const SESSION_STORAGE_KEY_PREFIX = 'sync-block-data-';
 
 // A store manager responsible for the lifecycle and state management of reference sync blocks in an editor instance.
 // Designed to manage local in-memory state and synchronize with an external data provider.
@@ -18,6 +19,7 @@ import { createSyncBlockNode } from '../utils/utils';
 // Can be used in both editor and renderer contexts.
 export class ReferenceSyncBlockStoreManager {
   constructor(dataProvider) {
+    var _this$dataProvider;
     // Keeps track of addition and deletion of reference synced blocks on the document
     // This starts as true to always flush the cache when document is saved for the first time
     // to cater the case when a editor session is closed without document being updated right after reference block is deleted
@@ -63,6 +65,9 @@ export class ReferenceSyncBlockStoreManager {
     this.graphqlSubscriptions = new Map();
     this.subscriptionChangeListeners = new Set();
     this.newlyAddedSyncBlocks = new Set();
+
+    // The provider might have SSR data cache already set, so we need to update the cache in session storage
+    this.setSSRDataInSessionStorage((_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.getNodeDataCacheKeys());
   }
 
   /**
@@ -173,9 +178,53 @@ export class ReferenceSyncBlockStoreManager {
     this.fireAnalyticsEvent = fireAnalyticsEvent;
   }
   getInitialSyncBlockData(resourceId) {
-    var _this$dataProvider, _this$dataProvider$ge;
+    var _this$dataProvider2, _this$dataProvider2$g;
     const syncBlockNode = createSyncBlockNode('', resourceId);
-    return (_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;
+    const data = (_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 (data) {
+      return data;
+    }
+    if (fg('platform_synced_block_patch_3')) {
+      const sessionData = this.getSyncBlockDataFromSessionStorage(resourceId);
+      if (sessionData) {
+        return sessionData;
+      }
+    }
+    return undefined;
+  }
+  updateCacheInSessionStorage(resourceId) {
+    try {
+      const latestData = this.getFromCache(resourceId);
+      if (latestData) {
+        sessionStorage.setItem(`${SESSION_STORAGE_KEY_PREFIX}${resourceId}`, JSON.stringify(latestData));
+      }
+    } catch (error) {
+      logException(error, {
+        location: 'editor-synced-block-provider/referenceSyncBlockStoreManager/updateCacheInSessionStorage'
+      });
+    }
+  }
+  getSyncBlockDataFromSessionStorage(resourceId) {
+    let sessionData = null;
+    try {
+      sessionData = sessionStorage.getItem(`${SESSION_STORAGE_KEY_PREFIX}${resourceId}`);
+    } catch (error) {
+      logException(error, {
+        location: 'editor-synced-block-provider/referenceSyncBlockStoreManager/getSyncBlockDataFromSessionStorage'
+      });
+      return undefined;
+    }
+    if (!sessionData) {
+      return undefined;
+    }
+    try {
+      return JSON.parse(sessionData);
+    } catch (error) {
+      logException(error, {
+        location: 'editor-synced-block-provider/referenceSyncBlockStoreManager/getSyncBlockDataFromSessionStorage'
+      });
+      return undefined;
+    }
   }
 
   /**
@@ -218,12 +267,12 @@ export class ReferenceSyncBlockStoreManager {
    * @param resourceId - The resource ID of the block to subscribe to
    */
   setupGraphQLSubscription(resourceId) {
-    var _this$dataProvider2;
+    var _this$dataProvider3;
     // Don't set up duplicate subscriptions
     if (this.graphqlSubscriptions.has(resourceId)) {
       return;
     }
-    if (!((_this$dataProvider2 = this.dataProvider) !== null && _this$dataProvider2 !== void 0 && _this$dataProvider2.subscribeToBlockUpdates)) {
+    if (!((_this$dataProvider3 = this.dataProvider) !== null && _this$dataProvider3 !== void 0 && _this$dataProvider3.subscribeToBlockUpdates)) {
       return;
     }
     const unsubscribe = this.dataProvider.subscribeToBlockUpdates(resourceId, syncBlockInstance => {
@@ -585,8 +634,8 @@ export class ReferenceSyncBlockStoreManager {
       resourceId
     } = syncBlock;
     if (resourceId) {
-      var _this$dataProvider3;
-      (_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 ? void 0 : _this$dataProvider3.updateCache({
+      var _this$dataProvider4;
+      (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 ? void 0 : _this$dataProvider4.updateCache({
         [resourceId]: syncBlock
       }, {
         strategy: 'merge',
@@ -598,6 +647,9 @@ export class ReferenceSyncBlockStoreManager {
           callback(syncBlock);
         });
       }
+      if (fg('platform_synced_block_patch_3')) {
+        this.updateCacheInSessionStorage(resourceId);
+      }
     }
   }
   updateSourceTitleSubscriptions(resourceId, title) {
@@ -609,13 +661,13 @@ export class ReferenceSyncBlockStoreManager {
     }
   }
   getFromCache(resourceId) {
-    var _this$dataProvider4, _this$dataProvider4$g;
+    var _this$dataProvider5, _this$dataProvider5$g;
     const syncBlockNode = createSyncBlockNode('', resourceId);
-    return (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 ? void 0 : (_this$dataProvider4$g = _this$dataProvider4.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider4$g === void 0 ? void 0 : _this$dataProvider4$g.data;
+    return (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 ? void 0 : (_this$dataProvider5$g = _this$dataProvider5.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider5$g === void 0 ? void 0 : _this$dataProvider5$g.data;
   }
   deleteFromCache(resourceId) {
-    var _this$dataProvider5;
-    (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 ? void 0 : _this$dataProvider5.removeFromCache([resourceId]);
+    var _this$dataProvider6;
+    (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 ? void 0 : _this$dataProvider6.removeFromCache([resourceId]);
     this.providerFactories.delete(resourceId);
   }
   debouncedBatchedFetchSyncBlocks(resourceId) {
@@ -632,8 +684,16 @@ export class ReferenceSyncBlockStoreManager {
       this.scheduledBatchFetch();
     }
   }
+  setSSRDataInSessionStorage(resourceIds) {
+    if (!resourceIds || resourceIds.length === 0) {
+      return;
+    }
+    resourceIds.forEach(resourceId => {
+      this.updateCacheInSessionStorage(resourceId);
+    });
+  }
   subscribeToSyncBlock(resourceId, localId, callback) {
-    var _this$dataProvider6, _this$dataProvider6$g;
+    var _this$dataProvider7, _this$dataProvider7$g;
     // Cancel any pending cache deletion for this resourceId.
     // This handles the case where a block is moved - the old component unmounts
     // (scheduling deletion) but the new component mounts and subscribes before
@@ -662,7 +722,7 @@ export class ReferenceSyncBlockStoreManager {
     const syncBlockNode = createSyncBlockNode(localId, resourceId);
 
     // call the callback immediately if we have cached data
-    const cachedData = (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 ? void 0 : (_this$dataProvider6$g = _this$dataProvider6.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider6$g === void 0 ? void 0 : _this$dataProvider6$g.data;
+    const cachedData = (_this$dataProvider7 = this.dataProvider) === null || _this$dataProvider7 === void 0 ? void 0 : (_this$dataProvider7$g = _this$dataProvider7.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider7$g === void 0 ? void 0 : _this$dataProvider7$g.data;
     if (cachedData) {
       callback(cachedData);
     } else {
@@ -883,7 +943,7 @@ export class ReferenceSyncBlockStoreManager {
     }
     const parentInfo = this.dataProvider.retrieveSyncBlockParentInfo((_syncBlock$data2 = syncBlock.data) === null || _syncBlock$data2 === void 0 ? void 0 : _syncBlock$data2.sourceAri, (_syncBlock$data3 = syncBlock.data) === null || _syncBlock$data3 === void 0 ? void 0 : _syncBlock$data3.product);
     if (!parentInfo) {
-      throw new Error('Unable to retrive sync block parent info');
+      throw new Error('Unable to retrieve sync block parent info');
     }
     const {
       contentId,
@@ -1043,7 +1103,7 @@ export class ReferenceSyncBlockStoreManager {
     return success;
   }
   destroy() {
-    var _this$dataProvider7, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo6;
+    var _this$dataProvider8, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo6;
     // Cancel any queued flush to prevent it from running after destroy
     if (this.queuedFlushTimeout) {
       clearTimeout(this.queuedFlushTimeout);
@@ -1052,7 +1112,7 @@ export class ReferenceSyncBlockStoreManager {
 
     // Clean up all GraphQL subscriptions first
     this.cleanupAllGraphQLSubscriptions();
-    (_this$dataProvider7 = this.dataProvider) === null || _this$dataProvider7 === void 0 ? void 0 : _this$dataProvider7.resetCache();
+    (_this$dataProvider8 = this.dataProvider) === null || _this$dataProvider8 === void 0 ? void 0 : _this$dataProvider8.resetCache();
     this.scheduledBatchFetch.cancel();
     this.pendingFetchRequests.clear();
     this.dataProvider = undefined;
@@ -1060,7 +1120,6 @@ export class ReferenceSyncBlockStoreManager {
     this.titleSubscriptions.clear();
     this.syncBlockFetchDataRequests.clear();
     this.syncBlockSourceInfoRequests.clear();
-    this.providerFactories.clear();
     this.isRefreshingSubscriptions = false;
     this.useRealTimeSubscriptions = false;
     this.subscriptionChangeListeners.clear();

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

@@ -204,7 +204,7 @@ export class SourceSyncBlockStoreManager {
    * Create a bodiedSyncBlock node with empty content to backend
    * @param attrs attributes Ids of the node
    */
-  createBodiedSyncBlockNode(attrs, onCompletion, nodeData) {
+  createBodiedSyncBlockNode(attrs, onCompletion) {
     const {
       resourceId,
       localId: blockInstanceId

package/dist/es2019/utils/errorHandling.js

@@ -1,4 +1,5 @@
 import { ACTION, ACTION_SUBJECT, EVENT_TYPE, ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
+import { fg } from '@atlaskit/platform-feature-flags';
 export const stringifyError = error => {
   try {
     return JSON.stringify(error);
@@ -41,7 +42,26 @@ export const fetchSuccessPayload = (resourceId, blockInstanceId, sourceProduct)
     })
   }
 });
-export const createSuccessPayload = resourceId => ({
+export const createSuccessPayload = resourceId => {
+  return fg('platform_synced_block_patch_3') ? {
+    action: ACTION.INSERTED,
+    actionSubject: ACTION_SUBJECT.DOCUMENT,
+    actionSubjectId: ACTION_SUBJECT_ID.BODIED_SYNCED_BLOCK,
+    eventType: EVENT_TYPE.TRACK,
+    attributes: {
+      resourceId
+    }
+  } : {
+    action: ACTION.INSERTED,
+    actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
+    actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE,
+    eventType: EVENT_TYPE.OPERATIONAL,
+    attributes: {
+      resourceId
+    }
+  };
+};
+export const createSuccessPayloadNew = resourceId => ({
   action: ACTION.INSERTED,
   actionSubject: ACTION_SUBJECT.SYNCED_BLOCK,
   actionSubjectId: ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE,

package/dist/es2019/utils/resolveSyncBlockInstance.js

@@ -1,8 +1,9 @@
 import { SyncBlockError } from '../common/types';
 /**
  * Merges two SyncBlockInstance objects,
- * currently it only preserves the sourceURL from the old result,
- * but this can be extended in the future to preserve other fields and resolve conflicts as needed.
+ * preserving sourceURL, sourceTitle, sourceSubType, and onSameDocument from the old result
+ * when the new result does not have them.
+ * This can be extended in the future to resolve other conflicts as needed,
  * e.g. compare timestamps or version numbers to determine which data is more recent.
  *
  * @param oldResult - The existing SyncBlockInstance object.

package/dist/es2019/utils/retry.js

@@ -21,6 +21,9 @@ export const fetchWithRetry = async (url, options, retriesRemaining = 3, delay =
     return response;
   }
   const retryAfter = response.headers.get('Retry-After');
-  await new Promise(resolve => setTimeout(resolve, retryAfter ? parseRetryAfter(retryAfter) : delay));
+  await new Promise(resolve => {
+    var _ref;
+    return setTimeout(resolve, (_ref = retryAfter ? parseRetryAfter(retryAfter) : undefined) !== null && _ref !== void 0 ? _ref : delay);
+  });
   return fetchWithRetry(url, options, retriesRemaining - 1, delay * 2);
 };

package/dist/esm/clients/block-service/ari.js

@@ -29,8 +29,10 @@ export var generateBlockAriFromReference = function generateBlockAriFromReferenc
 };
 
 /**
- * Extracts the local ID from a block ARI.
- * @param ari - the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ * Extracts the local ID from a source block ARI.
+ * Designed for source block ARIs of the form: ari:cloud:blocks:{cloudId}:synced-block/{localId}
+ * where the localId is a UUID immediately after synced-block/.
+ * @param ari - the source block ARI. E.G ari:cloud:blocks:cloudId:synced-block/79d4f3f4-51df-451b-b9a1-751bc77b1e77
  * @returns the localId of the block node. A randomly generated UUID
  */
 export var getLocalIdFromBlockResourceId = function getLocalIdFromBlockResourceId(ari) {
@@ -38,7 +40,7 @@ export var getLocalIdFromBlockResourceId = function getLocalIdFromBlockResourceI
   if (match !== null && match !== void 0 && match[1]) {
     return match[1];
   }
-  throw new Error("Invalid page ARI: ".concat(ari));
+  throw new Error("Invalid block ARI: ".concat(ari));
 };
 export var getProductFromSourceAri = function getProductFromSourceAri(ari) {
   var jiraMatch = ari === null || ari === void 0 ? void 0 : ari.search(/ari:cloud:jira:.*/);

package/dist/esm/index.js

@@ -10,17 +10,17 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 
 // clients
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId } from './clients/block-service/ari';
+export { BlockError } from './clients/block-service/blockService';
 export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri } from './clients/confluence/ari';
 export { fetchMediaToken } from './clients/confluence/fetchMediaToken';
 export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';
 
 // providers
-export { useMemoizedBlockServiceAPIProviders, useMemoizedBlockServiceFetchOnlyAPIProvider, fetchReferences, batchFetchData } from './providers/block-service/blockServiceAPI';
+export { useMemoizedBlockServiceAPIProviders, useMemoizedBlockServiceFetchOnlyAPIProvider, fetchReferences, batchFetchData, blockAriToResourceId, convertToSyncBlockData, extractResourceIdFromBlockAri } from './providers/block-service/blockServiceAPI';
 export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
-export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
-
+export { SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
 // store managers
-
+export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 
 // utils

package/dist/esm/providers/syncBlockProvider.js

@@ -16,27 +16,27 @@ import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
 import { fetchJiraWorkItemInfo } from '../clients/jira/sourceInfo';
 import { SyncBlockError } from '../common/types';
-import { SyncBlockDataProvider } from './types';
-export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
+import { SyncBlockDataProviderInterface } from './types';
+export var SyncedBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
   /**
-   * Constructor for the SyncBlockProvider
+   * Constructor for the SyncedBlockProvider
    *
    * @param fetchProvider
    * @param writeProvider
    * @param nestedRendererDataProviders
    */
-  function SyncBlockProvider(fetchProvider, writeProvider) {
+  function SyncedBlockProvider(fetchProvider, writeProvider) {
     var _this;
-    _classCallCheck(this, SyncBlockProvider);
-    _this = _callSuper(this, SyncBlockProvider);
+    _classCallCheck(this, SyncedBlockProvider);
+    _this = _callSuper(this, SyncedBlockProvider);
     _defineProperty(_this, "name", 'syncBlockProvider');
     _this.fetchProvider = fetchProvider;
     _this.writeProvider = writeProvider;
     _this.providerOptions = {};
     return _this;
   }
-  _inherits(SyncBlockProvider, _SyncBlockDataProvide);
-  return _createClass(SyncBlockProvider, [{
+  _inherits(SyncedBlockProvider, _SyncBlockDataProvide);
+  return _createClass(SyncedBlockProvider, [{
     key: "setProviderOptions",
     value: function setProviderOptions(providerOptions) {
       this.providerOptions = providerOptions;
@@ -434,11 +434,11 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
       return undefined;
     }
   }]);
-}(SyncBlockDataProvider);
+}(SyncBlockDataProviderInterface);
 var createSyncedBlockProvider = function createSyncedBlockProvider(_ref) {
   var fetchProvider = _ref.fetchProvider,
     writeProvider = _ref.writeProvider;
-  return new SyncBlockProvider(fetchProvider, writeProvider);
+  return new SyncedBlockProvider(fetchProvider, writeProvider);
 };
 export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(_ref2) {
   var fetchProvider = _ref2.fetchProvider,

package/dist/esm/providers/types.js

@@ -13,11 +13,11 @@ import { NodeDataProvider } from '@atlaskit/node-data-provider';
  * This will be used in both data processing and rendering contexts.
  */
 
-export var SyncBlockDataProvider = /*#__PURE__*/function (_NodeDataProvider) {
-  function SyncBlockDataProvider() {
-    _classCallCheck(this, SyncBlockDataProvider);
-    return _callSuper(this, SyncBlockDataProvider, arguments);
+export var SyncBlockDataProviderInterface = /*#__PURE__*/function (_NodeDataProvider) {
+  function SyncBlockDataProviderInterface() {
+    _classCallCheck(this, SyncBlockDataProviderInterface);
+    return _callSuper(this, SyncBlockDataProviderInterface, arguments);
   }
-  _inherits(SyncBlockDataProvider, _NodeDataProvider);
-  return _createClass(SyncBlockDataProvider);
+  _inherits(SyncBlockDataProviderInterface, _NodeDataProvider);
+  return _createClass(SyncBlockDataProviderInterface);
 }(NodeDataProvider);