@atlaskit/editor-synced-block-provider 2.10.5 → 2.11.0

package/dist/esm/hooks/useFetchSyncBlockData.js

@@ -2,9 +2,11 @@ import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { useCallback, useEffect, useState } from 'react';
+import { logException } from '@atlaskit/editor-common/monitoring';
 import { SyncBlockError } from '../common/types';
+import { fetchErrorPayload } from '../utils/errorHandling';
 import { createSyncBlockNode } from '../utils/utils';
-export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId) {
+export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId, fireAnalyticsEvent) {
   var _useState = useState(null),
     _useState2 = _slicedToArray(_useState, 2),
     syncBlockInstance = _useState2[0],
@@ -24,36 +26,43 @@ export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, resou
           }
           return _context.abrupt("return");
         case 2:
+          _context.prev = 2;
           syncBlockNode = resourceId && localId ? createSyncBlockNode(localId, resourceId) : null;
           if (syncBlockNode) {
-            _context.next = 5;
+            _context.next = 6;
             break;
           }
-          return _context.abrupt("return");
-        case 5:
+          throw new Error('Failed to create sync block node from resourceid and localid');
+        case 6:
           setIsLoading(true);
-          _context.prev = 6;
+
+          // Fetch sync block data, the `subscribeToSyncBlock` will update the state once data is fetched
           _context.next = 9;
           return manager.referenceManager.fetchSyncBlocksData([syncBlockNode]);
         case 9:
-          _context.next = 14;
+          _context.next = 16;
           break;
         case 11:
           _context.prev = 11;
-          _context.t0 = _context["catch"](6);
+          _context.t0 = _context["catch"](2);
+          logException(_context.t0, {
+            location: 'editor-synced-block-provider/useFetchSyncBlockData'
+          });
+          fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 || fireAnalyticsEvent(fetchErrorPayload(_context.t0.message));
+
           // Set error state if fetching fails
           setSyncBlockInstance({
             resourceId: resourceId || '',
             error: SyncBlockError.Errored
           });
-        case 14:
+        case 16:
           setIsLoading(false);
-        case 15:
+        case 17:
         case "end":
           return _context.stop();
       }
-    }, _callee, null, [[6, 11]]);
-  })), [isLoading, localId, manager.referenceManager, resourceId]);
+    }, _callee, null, [[2, 11]]);
+  })), [isLoading, localId, manager.referenceManager, resourceId, fireAnalyticsEvent]);
   useEffect(function () {
     var unsubscribe = manager.referenceManager.subscribeToSyncBlock(resourceId || '', localId || '', function (data) {
       setSyncBlockInstance(data);

package/dist/esm/hooks/useHandleContentChanges.js

@@ -1,10 +1,6 @@
 import { useEffect } from 'react';
 export var useHandleContentChanges = function useHandleContentChanges(manager, syncBlockNode) {
   useEffect(function () {
-    try {
-      manager.sourceManager.updateSyncBlockData(syncBlockNode);
-    } catch (_unused) {
-      //TODO: EDITOR-1921 - add error analytics
-    }
+    manager.sourceManager.updateSyncBlockData(syncBlockNode);
   }, [manager, syncBlockNode]);
 };

package/dist/esm/index.js

@@ -15,7 +15,7 @@ export { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageARIFromCo
 // providers
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders } from './providers/confluence/confluenceContentAPI';
-export { fetchConfluenceSourceInfo } from './clients/confluence/sourceInfo';
+export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
 // store managers
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';

package/dist/esm/providers/block-service/blockServiceAPI.js

@@ -89,33 +89,22 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
       }
       return fetchData;
     }()
-  }, {
-    key: "retrieveSourceInfoFetchData",
-    value: function retrieveSourceInfoFetchData(resourceId, pageARI) {
-      var sourceLocalId;
-      try {
-        sourceLocalId = getLocalIdFromBlockResourceId(resourceId);
-      } catch (error) {
-        // EDITOR-1921: log analytic here, safe to continue
-      }
-      return {
-        pageARI: pageARI,
-        sourceLocalId: sourceLocalId
-      };
-    }
   }]);
 }();
 /**
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
-  function BlockServiceADFWriteProvider() {
+  function BlockServiceADFWriteProvider(sourceAri, product) {
     _classCallCheck(this, BlockServiceADFWriteProvider);
+    this.sourceAri = sourceAri;
+    this.product = product;
   }
+
+  // it will first try to update and if it can't (404) then it will try to create
   return _createClass(BlockServiceADFWriteProvider, [{
     key: "writeData",
-    value: // it will first try to update and if it can't (404) then it will try to create
-    function () {
+    value: function () {
       var _writeData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(data) {
         var resourceId;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
@@ -147,8 +136,8 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               return createSyncedBlock({
                 blockAri: resourceId,
                 blockInstanceId: data.blockInstanceId,
-                sourceAri: resourceId,
-                product: 'confluence-page',
+                sourceAri: this.sourceAri,
+                product: this.product,
                 content: JSON.stringify(data.content)
               });
             case 13:
@@ -168,7 +157,7 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
             case "end":
               return _context2.stop();
           }
-        }, _callee2, null, [[1, 7]]);
+        }, _callee2, this, [[1, 7]]);
       }));
       function writeData(_x2) {
         return _writeData.apply(this, arguments);
@@ -224,22 +213,24 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     }()
   }, {
     key: "generateResourceId",
-    value: function generateResourceId(sourceId, localId) {
-      return blockResourceIdFromSourceAndLocalId(sourceId, localId);
+    value: function generateResourceId(sourceAri, localId) {
+      return blockResourceIdFromSourceAndLocalId(sourceAri, localId);
     }
   }]);
 }();
 /**
  * Factory function to create both providers with shared configuration
  */
-var createBlockServiceAPIProviders = function createBlockServiceAPIProviders() {
+var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product) {
   var fetchProvider = new BlockServiceADFFetchProvider();
-  var writeProvider = new BlockServiceADFWriteProvider();
+  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product);
   return {
     fetchProvider: fetchProvider,
     writeProvider: writeProvider
   };
 };
-export var useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders() {
-  return useMemo(createBlockServiceAPIProviders, []);
+export var useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product) {
+  return useMemo(function () {
+    return createBlockServiceAPIProviders(sourceAri, product);
+  }, [sourceAri, product]);
 };

package/dist/esm/providers/confluence/confluenceContentAPI.js

@@ -7,7 +7,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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 _regeneratorRuntime from "@babel/runtime/regenerator";
 import { useMemo } from 'react';
-import { getConfluencePageAri, getPageARIFromContentPropertyResourceId, getLocalIdFromConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
+import { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
 import { getContentProperty, createContentProperty, updateContentProperty, deleteContentProperty } from '../../clients/confluence/contentProperty';
 import { isBlogPageType } from '../../clients/confluence/utils';
 import { SyncBlockError } from '../../common/types';
@@ -140,21 +140,6 @@ var ConfluenceADFFetchProvider = /*#__PURE__*/function () {
       }
       return fetchData;
     }()
-  }, {
-    key: "retrieveSourceInfoFetchData",
-    value: function retrieveSourceInfoFetchData(resourceId) {
-      var pageARI = getPageARIFromContentPropertyResourceId(resourceId);
-      var sourceLocalId;
-      try {
-        sourceLocalId = getLocalIdFromConfluencePageAri(resourceId);
-      } catch (error) {
-        // EDITOR-1921: log analytic here, safe to continue
-      }
-      return {
-        pageARI: pageARI,
-        sourceLocalId: sourceLocalId
-      };
-    }
   }]);
 }();
 /**

package/dist/esm/providers/syncBlockProvider.js

@@ -11,7 +11,7 @@ function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstruct
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { useMemo } from 'react';
 import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari';
-import { fetchConfluenceSourceInfo } from '../clients/confluence/sourceInfo';
+import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
 import { SyncBlockError } from '../common/types';
 import { SyncBlockDataProvider } from '../providers/types';
 export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
@@ -84,7 +84,7 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
           return data;
         }, function () {
           return {
-            status: SyncBlockError.Errored,
+            error: SyncBlockError.Errored,
             resourceId: resourceId
           };
         });
@@ -202,34 +202,28 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     }
 
     /**
-     * Retrieve the source info from the source id
+     * Fetch the source info from the source id
      *
-     * @param node
+     * @param params
+     * @param params.sourceAri - The source ARI
+     * @param params.sourceProduct - The source product. e.g. 'confluence-page', 'jira-work-item'
      *
      * @returns The source info
      */
   }, {
-    key: "retrieveSyncBlockSourceInfo",
-    value: function retrieveSyncBlockSourceInfo(node) {
-      // with content API, this is the concatenation of the page ARI and the block's localId.
-      // with block service, this is the ARI of the block.
-      // this can be cleaned up from the specific providers and placed here after platform_synced_blocks_block_service_provider
-      var resourceId = node.attrs.resourceId;
-      var pageARI;
-      var sourceLocalId;
-      if (resourceId && typeof resourceId === 'string') {
-        try {
-          var fetchData = this.fetchProvider.retrieveSourceInfoFetchData(resourceId, this.sourceId);
-          pageARI = fetchData.pageARI;
-          sourceLocalId = fetchData.sourceLocalId;
-        } catch (error) {
-          return Promise.reject(error);
-        }
+    key: "fetchSyncBlockSourceInfo",
+    value: function fetchSyncBlockSourceInfo(localId, sourceAri, sourceProduct, fireAnalyticsEvent) {
+      if (!sourceAri || !sourceProduct) {
+        return Promise.reject(new Error('Source ari or source product is undefined'));
+      }
+      switch (sourceProduct) {
+        case 'confluence-page':
+          return fetchConfluencePageInfo(sourceAri, localId, fireAnalyticsEvent);
+        case 'jira-work-item':
+          return Promise.reject(new Error('Jira work item source product not supported'));
+        default:
+          return Promise.reject(new Error("".concat(sourceProduct, " source product not supported")));
       }
-
-      // TODO: EDITOR-3312 - based on the source sync block product,
-      // execute fetchConfluenceSourceInfo or fetchJiraItemSourceInfo or similar...
-      return pageARI ? fetchConfluenceSourceInfo(pageARI, sourceLocalId) : Promise.resolve(undefined);
     }
   }, {
     key: "generateResourceId",
@@ -251,32 +245,28 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     /**
      * Retrieve the parent info for the sync block
      *
-     * @param resourceId
-     * @param syncBlockInstance
+     * @param sourceAri - The source ARI
+     * @param sourceProduct - The source product. e.g. 'confluence-page', 'jira-work-item'
      *
      * @returns The parent info for the sync block
      */
   }, {
     key: "retrieveSyncBlockParentInfo",
-    value: function retrieveSyncBlockParentInfo(syncBlockInstance) {
-      if (!syncBlockInstance || !syncBlockInstance.data) {
+    value: function retrieveSyncBlockParentInfo(sourceAri, sourceProduct) {
+      if (!sourceAri || !sourceProduct) {
         return undefined;
       }
-      var _syncBlockInstance$da = syncBlockInstance.data,
-        sourceAri = _syncBlockInstance$da.sourceAri,
-        product = _syncBlockInstance$da.product;
-      if (!sourceAri || !product) {
-        return undefined;
+      switch (sourceProduct) {
+        case 'confluence-page':
+          return {
+            contentId: getPageIdAndTypeFromConfluencePageAri(sourceAri).id,
+            contentProduct: sourceProduct
+          };
+        case 'jira-work-item':
+          throw new Error('Jira work item source product not supported');
+        default:
+          throw new Error("".concat(sourceProduct, " source product not supported"));
       }
-
-      // TODO: EDITOR-3312 - based on the source sync block product,
-      // execute getPageIdAndTypeFromConfluencePageAri or getJiraItemIdAndTypeFromJiraItemAri or similar...
-      var _getPageIdAndTypeFrom = getPageIdAndTypeFromConfluencePageAri(sourceAri),
-        contentId = _getPageIdAndTypeFrom.id;
-      return {
-        contentId: contentId,
-        contentProduct: product
-      };
     }
   }]);
 }(SyncBlockDataProvider);