@atlaskit/editor-synced-block-provider 3.5.4 → 3.6.0

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

@@ -45,6 +45,16 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: function setCreateExperience(createExperience) {
       this.createExperience = createExperience;
     }
+  }, {
+    key: "setSaveExperience",
+    value: function setSaveExperience(saveExperience) {
+      this.saveExperience = saveExperience;
+    }
+  }, {
+    key: "setDeleteExperience",
+    value: function setDeleteExperience(deleteExperience) {
+      this.deleteExperience = deleteExperience;
+    }
   }, {
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
@@ -93,17 +103,11 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: (function () {
       var _flush = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
         var _this2 = this;
-        var bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults, _this$fireAnalyticsEv2;
+        var bodiedSyncBlockNodes, bodiedSyncBlockData, _this$saveExperience, writeResults, successfulSaved, failedSave, _this$saveExperience2, _this$saveExperience3, _this$saveExperience4, _this$fireAnalyticsEv2;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               _context.prev = 0;
-              if (this.dataProvider) {
-                _context.next = 3;
-                break;
-              }
-              throw new Error('Data provider not set');
-            case 3:
               bodiedSyncBlockNodes = [];
               bodiedSyncBlockData = [];
               Array.from(this.syncBlockCache.values()).forEach(function (syncBlockData) {
@@ -128,14 +132,25 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 }
               });
               if (!(bodiedSyncBlockNodes.length === 0)) {
-                _context.next = 8;
+                _context.next = 6;
                 break;
               }
               return _context.abrupt("return", Promise.resolve(true));
-            case 8:
-              _context.next = 10;
-              return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
+            case 6:
+              // only start the save experience if we have sync blocks to save
+              if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
+                (_this$saveExperience = this.saveExperience) === null || _this$saveExperience === void 0 || _this$saveExperience.start({});
+              }
+              ;
+              if (this.dataProvider) {
+                _context.next = 10;
+                break;
+              }
+              throw new Error('Data provider not set');
             case 10:
+              _context.next = 12;
+              return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
+            case 12:
               writeResults = _context.sent;
               writeResults.forEach(function (result) {
                 // set isDirty to true for cases where it failed to save the sync block to the BE
@@ -146,37 +161,75 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                   }
                 }
               });
+              successfulSaved = writeResults.filter(function (result) {
+                return result.resourceId && !result.error;
+              }).map(function (result) {
+                return {
+                  resourceId: result.resourceId
+                };
+              });
+              failedSave = writeResults.filter(function (result) {
+                return !result.resourceId || result.error;
+              }).map(function (result) {
+                return {
+                  resourceId: result.resourceId || 'unknown',
+                  failReason: result.error || 'Failed to save sync blocks'
+                };
+              });
               if (!writeResults.every(function (result) {
                 return result.resourceId && !result.error;
               })) {
-                _context.next = 16;
+                _context.next = 22;
                 break;
               }
+              if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
+                (_this$saveExperience2 = this.saveExperience) === null || _this$saveExperience2 === void 0 || _this$saveExperience2.success({
+                  metadata: {
+                    successfulSaved: successfulSaved
+                  }
+                });
+              }
+              ;
               return _context.abrupt("return", true);
-            case 16:
-              writeResults.filter(function (result) {
-                return !result.resourceId || result.error;
-              }).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'));
-              });
+            case 22:
+              if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
+                (_this$saveExperience3 = this.saveExperience) === null || _this$saveExperience3 === void 0 || _this$saveExperience3.failure({
+                  metadata: {
+                    successfulSaved: successfulSaved,
+                    failedSave: failedSave
+                  }
+                });
+              } else {
+                writeResults.filter(function (result) {
+                  return !result.resourceId || result.error;
+                }).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'));
+                });
+              }
               return _context.abrupt("return", false);
-            case 18:
-              _context.next = 25;
+            case 24:
+              _context.next = 31;
               break;
-            case 20:
-              _context.prev = 20;
+            case 26:
+              _context.prev = 26;
               _context.t0 = _context["catch"](0);
               (0, _monitoring.logException)(_context.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
-              (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, (0, _errorHandling.updateErrorPayload)(_context.t0.message));
+              if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
+                (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.failure({
+                  reason: _context.t0.message
+                });
+              } else {
+                (_this$fireAnalyticsEv2 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv2 === void 0 || _this$fireAnalyticsEv2.call(this, (0, _errorHandling.updateErrorPayload)(_context.t0.message));
+              }
               return _context.abrupt("return", false);
-            case 25:
+            case 31:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 20]]);
+        }, _callee, this, [[0, 26]]);
       }));
       function flush() {
         return _flush.apply(this, arguments);
@@ -327,7 +380,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: function () {
       var _delete2 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(syncBlockIds, onDelete, onDeleteCompleted) {
         var _this5 = this;
-        var results, callback, isDeleteSuccessful, _this$fireAnalyticsEv4;
+        var results, callback, isDeleteSuccessful, _this$deleteExperienc, successfulDeleted, failedDelete, _this$deleteExperienc2, _this$fireAnalyticsEv4;
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
@@ -361,12 +414,36 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
                 callback = function callback(Ids) {
                   _this5.setPendingDeletion(Ids, false);
                 };
-                results.filter(function (result) {
-                  return result.resourceId === undefined;
-                }).forEach(function (result) {
-                  var _this5$fireAnalyticsE;
-                  (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, (0, _errorHandling.deleteErrorPayload)(result.error || 'Failed to delete synced block'));
-                });
+                if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
+                  successfulDeleted = results.filter(function (result) {
+                    return result.success;
+                  }).map(function (result) {
+                    return {
+                      resourceId: result.resourceId
+                    };
+                  });
+                  failedDelete = results.filter(function (result) {
+                    return !result.success;
+                  }).map(function (result) {
+                    return {
+                      resourceId: result.resourceId || 'unknown',
+                      failReason: result.error || 'Failed to delete sync block'
+                    };
+                  });
+                  (_this$deleteExperienc = this.deleteExperience) === null || _this$deleteExperienc === void 0 || _this$deleteExperienc.failure({
+                    metadata: {
+                      successfulDeleted: successfulDeleted,
+                      failedDelete: failedDelete
+                    }
+                  });
+                } else {
+                  results.filter(function (result) {
+                    return result.resourceId === undefined;
+                  }).forEach(function (result) {
+                    var _this5$fireAnalyticsE;
+                    (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, (0, _errorHandling.deleteErrorPayload)(result.error || 'Failed to delete synced block'));
+                  });
+                }
               }
               syncBlockIds.forEach(callback);
               return _context2.abrupt("return", isDeleteSuccessful);
@@ -379,7 +456,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
               (0, _monitoring.logException)(_context2.t0, {
                 location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
               });
-              (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, (0, _errorHandling.deleteErrorPayload)(_context2.t0.message));
+              if ((0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding')) {
+                (_this$deleteExperienc2 = this.deleteExperience) === null || _this$deleteExperienc2 === void 0 || _this$deleteExperienc2.failure({
+                  reason: _context2.t0.message
+                });
+              } else {
+                (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, (0, _errorHandling.deleteErrorPayload)(_context2.t0.message));
+              }
               onDeleteCompleted(false);
               return _context2.abrupt("return", false);
             case 21:

package/dist/cjs/utils/parseResourceId.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.parseResourceId = void 0;
+var _toArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toArray"));
+var _consts = require("../common/consts");
+var isSyncBlockProduct = function isSyncBlockProduct(product) {
+  return _consts.SYNC_BLOCK_PRODUCTS.includes(product);
+};
+var parseResourceId = exports.parseResourceId = function parseResourceId(resourceId) {
+  if (!resourceId) {
+    return undefined;
+  }
+  var _resourceId$split = resourceId.split('/'),
+    _resourceId$split2 = (0, _toArray2.default)(_resourceId$split),
+    product = _resourceId$split2[0],
+    contentId = _resourceId$split2[1],
+    uuid = _resourceId$split2[2],
+    rest = _resourceId$split2.slice(3);
+
+  // invalid if any part is missing or there are extra parts
+  if (!product || !contentId || !uuid || rest.length > 0) {
+    return undefined;
+  }
+
+  // invalid if product is not recognized
+  if (!isSyncBlockProduct(product)) {
+    return undefined;
+  }
+  return {
+    product: product,
+    contentId: contentId,
+    uuid: uuid
+  };
+};

package/dist/es2019/clients/confluence/fetchMediaToken.js

@@ -0,0 +1,68 @@
+import { logException } from '@atlaskit/editor-common/monitoring';
+import { fetchWithRetry } from '../../utils/retry';
+const COMMON_HEADERS = {
+  'Content-Type': 'application/json',
+  Accept: 'application/json'
+};
+const AGG_HEADERS = {
+  'X-ExperimentalApi': 'confluence-agg-beta'
+};
+const GRAPHQL_ENDPOINT = '/gateway/api/graphql';
+const GET_CONTENT_MEDIA_SESSION_OPERATION_NAME = 'MediaUploadTokenQuery';
+const GET_CONTENT_MEDIA_SESSION_QUERY = `query ${GET_CONTENT_MEDIA_SESSION_OPERATION_NAME}($contentId: ID!) {
+	contentMediaSession(contentId: $contentId) {
+		token {
+			value
+		}
+		configuration {
+			clientId
+			fileStoreUrl
+		}
+		collection
+	}
+}`;
+const getContentMediaSession = async contentId => {
+  const bodyData = {
+    query: GET_CONTENT_MEDIA_SESSION_QUERY,
+    operationName: GET_CONTENT_MEDIA_SESSION_OPERATION_NAME,
+    variables: {
+      contentId: contentId
+    }
+  };
+  const response = await fetchWithRetry(GRAPHQL_ENDPOINT, {
+    method: 'POST',
+    headers: {
+      ...COMMON_HEADERS,
+      ...AGG_HEADERS
+    },
+    body: JSON.stringify(bodyData)
+  });
+  if (!response.ok) {
+    throw new Error(`Failed to get content media session: ${response.statusText}`);
+  }
+  const result = await response.json();
+  return result;
+};
+export const fetchMediaToken = async contentId => {
+  try {
+    var _response$data, _contentData$token;
+    const response = await getContentMediaSession(contentId);
+    const contentData = (_response$data = response.data) === null || _response$data === void 0 ? void 0 : _response$data.contentMediaSession;
+    const token = contentData === null || contentData === void 0 ? void 0 : (_contentData$token = contentData.token) === null || _contentData$token === void 0 ? void 0 : _contentData$token.value;
+    const configuration = contentData === null || contentData === void 0 ? void 0 : contentData.configuration;
+    const collection = contentData === null || contentData === void 0 ? void 0 : contentData.collection;
+    if (!token || !configuration || !collection) {
+      throw new Error('Failed to get content media session data');
+    }
+    return Promise.resolve({
+      config: configuration,
+      token,
+      collectionId: collection
+    });
+  } catch (error) {
+    logException(error, {
+      location: 'editor-synced-block-provider/fetchMediaToken'
+    });
+    throw new Error(`Failed to get content media session: ${error}`);
+  }
+};

package/dist/es2019/clients/confluence/sourceInfo.js

@@ -1,6 +1,7 @@
 /* eslint-disable require-unicode-regexp  */
 
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getSourceInfoErrorPayload } from '../../utils/errorHandling';
 import { fetchWithRetry } from '../../utils/retry';
 import { getPageIdAndTypeFromConfluencePageAri } from './ari';
@@ -55,7 +56,7 @@ const getConfluenceSourceInfo = async ari => {
   }
   return await response.json();
 };
-export const fetchConfluencePageInfo = async (pageAri, localId, fireAnalyticsEvent) => {
+export const fetchConfluencePageInfoOld = async (pageAri, localId, fireAnalyticsEvent) => {
   try {
     var _response$data, _response$data$conten, _response$data$conten2, _contentData$space;
     const {
@@ -94,4 +95,36 @@ export const fetchConfluencePageInfo = async (pageAri, localId, fireAnalyticsEve
     fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? void 0 : fireAnalyticsEvent(getSourceInfoErrorPayload(error.message));
     return Promise.resolve(undefined);
   }
+};
+export const fetchConfluencePageInfoNew = async (pageAri, localId) => {
+  var _response$data2, _response$data2$conte, _response$data2$conte2, _contentData$space2;
+  const {
+    type: pageType
+  } = getPageIdAndTypeFromConfluencePageAri({
+    ari: pageAri
+  });
+  const response = await getConfluenceSourceInfo(pageAri);
+  const contentData = (_response$data2 = response.data) === null || _response$data2 === void 0 ? void 0 : (_response$data2$conte = _response$data2.content) === null || _response$data2$conte === void 0 ? void 0 : (_response$data2$conte2 = _response$data2$conte.nodes) === null || _response$data2$conte2 === void 0 ? void 0 : _response$data2$conte2[0];
+  const title = contentData === null || contentData === void 0 ? void 0 : contentData.title;
+  let url;
+  const {
+    base
+  } = (contentData === null || contentData === void 0 ? void 0 : contentData.links) || {};
+  if (base && contentData !== null && contentData !== void 0 && (_contentData$space2 = contentData.space) !== null && _contentData$space2 !== void 0 && _contentData$space2.key && contentData !== null && contentData !== void 0 && contentData.id) {
+    if (isBlogPageType(pageType)) {
+      url = `${base}/spaces/${contentData.space.key}/blog/edit-v2/${contentData.id}`;
+    } else if (contentData.subType === 'live') {
+      url = `${base}/spaces/${contentData.space.key}/pages/${contentData.id}`;
+    } else {
+      url = `${base}/spaces/${contentData.space.key}/pages/edit-v2/${contentData.id}`;
+    }
+  }
+  url = url && localId ? `${url}#block-${localId}` : url;
+  return Promise.resolve({
+    title,
+    url
+  });
+};
+export const fetchConfluencePageInfo = async (pageAri, localId, fireAnalyticsEvent) => {
+  return fg('platform_synced_block_dogfooding') ? await fetchConfluencePageInfoNew(pageAri, localId) : await fetchConfluencePageInfoOld(pageAri, localId, fireAnalyticsEvent);
 };

package/dist/es2019/common/consts.js

@@ -0,0 +1 @@
+export const SYNC_BLOCK_PRODUCTS = ['confluence-page', 'jira-work-item'];

package/dist/es2019/hooks/useFetchSyncBlockData.js

@@ -1,5 +1,6 @@
 import { useCallback, useEffect, useState } from 'react';
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
 import { fetchErrorPayload } from '../utils/errorHandling';
 import { createSyncBlockNode } from '../utils/utils';
@@ -45,7 +46,14 @@ export const useFetchSyncBlockData = (manager, resourceId, localId, fireAnalytic
       logException(error, {
         location: 'editor-synced-block-provider/useFetchSyncBlockData'
       });
-      fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? void 0 : fireAnalyticsEvent(fetchErrorPayload(error.message));
+      if (fg('platform_synced_block_dogfooding')) {
+        var _manager$referenceMan2, _manager$referenceMan3;
+        manager === null || manager === void 0 ? void 0 : (_manager$referenceMan2 = manager.referenceManager) === null || _manager$referenceMan2 === void 0 ? void 0 : (_manager$referenceMan3 = _manager$referenceMan2.fetchExperience) === null || _manager$referenceMan3 === void 0 ? void 0 : _manager$referenceMan3.failure({
+          reason: error.message
+        });
+      } else {
+        fireAnalyticsEvent === null || fireAnalyticsEvent === void 0 ? void 0 : fireAnalyticsEvent(fetchErrorPayload(error.message));
+      }
 
       // Set error state if fetching fails
       setFetchState({
@@ -75,6 +83,7 @@ export const useFetchSyncBlockData = (manager, resourceId, localId, fireAnalytic
   }, [localId, manager.referenceManager, resourceId]);
   return {
     isLoading,
+    ssrProviders: resourceId ? manager.referenceManager.getSSRProviders(resourceId) : null,
     providerFactory: manager.referenceManager.getProviderFactory(resourceId || ''),
     reloadData,
     syncBlockInstance

package/dist/es2019/index.js

@@ -11,6 +11,7 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 // clients
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId } from './clients/block-service/ari';
 export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri } from './clients/confluence/ari';
+export { fetchMediaToken } from './clients/confluence/fetchMediaToken';
 export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';
 
 // providers
@@ -24,6 +25,7 @@ export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager } from './store
 
 // utils
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { parseResourceId } from './utils/parseResourceId';
 export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes, getContentIdAndProductFromResourceId } from './utils/utils';
 export { fetchErrorPayload } from './utils/errorHandling';
 export { fetchReferences } from './providers/block-service/blockServiceAPI';