@atlaskit/editor-synced-block-provider 2.5.1 → 2.5.2

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.5.2
+
+### Patch Changes
+
+- [`7e3353721fa66`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7e3353721fa66) -
+  [ux] EDITOR-1822 update sync blocks ui to new design
+
 ## 2.5.1
 
 ### Patch Changes

package/dist/cjs/hooks/useFetchSyncBlockTitle.js

@@ -0,0 +1,24 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useFetchSyncBlockTitle = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("react");
+var useFetchSyncBlockTitle = exports.useFetchSyncBlockTitle = function useFetchSyncBlockTitle(manager, syncBlockNode) {
+  var _useState = (0, _react.useState)(undefined),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    sourceTitle = _useState2[0],
+    setSourceTitle = _useState2[1];
+  (0, _react.useEffect)(function () {
+    var unsubscribe = manager.subscribeToSyncBlockSourceTitle(syncBlockNode, function (title) {
+      setSourceTitle(title);
+    });
+    return function () {
+      unsubscribe();
+    };
+  }, [manager, syncBlockNode]);
+  return sourceTitle;
+};

package/dist/cjs/index.js

@@ -69,6 +69,12 @@ Object.defineProperty(exports, "useFetchSyncBlockData", {
     return _useFetchSyncBlockData.useFetchSyncBlockData;
   }
 });
+Object.defineProperty(exports, "useFetchSyncBlockTitle", {
+  enumerable: true,
+  get: function get() {
+    return _useFetchSyncBlockTitle.useFetchSyncBlockTitle;
+  }
+});
 Object.defineProperty(exports, "useHandleContentChanges", {
   enumerable: true,
   get: function get() {
@@ -90,6 +96,7 @@ Object.defineProperty(exports, "useMemoizedSyncedBlockProvider", {
 var _syncBlockProvider = require("./providers/syncBlockProvider");
 var _syncBlockStoreManager = require("./store-manager/syncBlockStoreManager");
 var _useFetchSyncBlockData = require("./hooks/useFetchSyncBlockData");
+var _useFetchSyncBlockTitle = require("./hooks/useFetchSyncBlockTitle");
 var _useHandleContentChanges = require("./hooks/useHandleContentChanges");
 var _types = require("./common/types");
 var _schema = require("./common/schema");

package/dist/cjs/providers/syncBlockProvider.js

@@ -133,8 +133,8 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
       return this.sourceId;
     }
   }, {
-    key: "retrieveSyncBlockSourceUrl",
-    value: function retrieveSyncBlockSourceUrl(node) {
+    key: "retrieveSyncBlockSourceUrlAndTitle",
+    value: function retrieveSyncBlockSourceUrlAndTitle(node) {
       var resourceId = node.attrs.resourceId;
       var pageARI;
       var sourceLocalId;
@@ -150,7 +150,7 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
           // EDITOR-1921: log analytic here, safe to continue
         }
       }
-      return pageARI ? fetchURLfromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
+      return pageARI ? fetchURLandTitlefromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
     }
   }]);
 }(_types2.SyncBlockDataProvider);
@@ -159,9 +159,9 @@ var useMemoizedSyncedBlockProvider = exports.useMemoizedSyncedBlockProvider = fu
     return new SyncBlockProvider(fetchProvider, writeProvider, sourceId);
   }, [fetchProvider, writeProvider, sourceId]);
 };
-var fetchURLfromARI = /*#__PURE__*/function () {
+var fetchURLandTitlefromARI = /*#__PURE__*/function () {
   var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(ari, sourceLocalId) {
-    var response, _payload$data, payload, url;
+    var response, _payload$data, _payload$data2, payload, url, title;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
@@ -187,17 +187,14 @@ var fetchURLfromARI = /*#__PURE__*/function () {
         case 6:
           payload = _context2.sent;
           url = payload === null || payload === void 0 || (_payload$data = payload.data) === null || _payload$data === void 0 ? void 0 : _payload$data.url;
-          if (!(typeof url === 'string')) {
-            _context2.next = 10;
-            break;
-          }
-          return _context2.abrupt("return", sourceLocalId ? url + "?block=".concat(sourceLocalId) : url);
-        case 10:
-          _context2.next = 13;
-          break;
+          title = payload === null || payload === void 0 || (_payload$data2 = payload.data) === null || _payload$data2 === void 0 ? void 0 : _payload$data2.name;
+          return _context2.abrupt("return", {
+            url: typeof url === 'string' ? sourceLocalId ? url + "?block=".concat(sourceLocalId) : url : undefined,
+            title: typeof title === 'string' ? title : undefined
+          });
         case 12:
           //eslint-disable-next-line no-console
-          console.error('Failed to fetch URL from ARI', response.statusText);
+          console.error('Failed to fetch URL and title from ARI', response.statusText);
         case 13:
           return _context2.abrupt("return", undefined);
         case 14:
@@ -206,7 +203,7 @@ var fetchURLfromARI = /*#__PURE__*/function () {
       }
     }, _callee2);
   }));
-  return function fetchURLfromARI(_x2, _x3) {
+  return function fetchURLandTitlefromARI(_x2, _x3) {
     return _ref.apply(this, arguments);
   };
 }();

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

@@ -24,6 +24,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     (0, _defineProperty2.default)(this, "isRefreshingSubscriptions", false);
     this.syncBlockCache = new Map();
     this.subscriptions = new Map();
+    this.titleSubscriptions = new Map();
     this.dataProvider = dataProvider;
     this.syncBlockURLRequests = new Map();
   }
@@ -112,8 +113,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       return refreshSubscriptions;
     }())
   }, {
-    key: "fetchSyncBlockSourceURL",
-    value: function fetchSyncBlockSourceURL(resourceId) {
+    key: "fetchSyncBlockSourceURLAndTitle",
+    value: function fetchSyncBlockSourceURLAndTitle(resourceId) {
       var _this = this;
       if (!resourceId || !this.dataProvider) {
         return;
@@ -123,13 +124,17 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       // we could optimise this further by checking if the sync block is on the same page as the source
       if (!this.syncBlockURLRequests.get(resourceId)) {
         this.syncBlockURLRequests.set(resourceId, true);
-        this.dataProvider.retrieveSyncBlockSourceUrl((0, _createSyncBlock.createSyncBlockNode)('', resourceId)).then(function (sourceURL) {
+        this.dataProvider.retrieveSyncBlockSourceUrlAndTitle((0, _createSyncBlock.createSyncBlockNode)('', resourceId)).then(function (sourceInfo) {
           var existingSyncBlock = _this.getFromCache(resourceId);
           if (existingSyncBlock && existingSyncBlock.data) {
             existingSyncBlock.data = _objectSpread(_objectSpread({}, existingSyncBlock.data), {}, {
-              sourceURL: sourceURL
+              sourceURL: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.url,
+              sourceTitle: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.title
             });
             _this.updateCache(existingSyncBlock);
+            if (sourceInfo !== null && sourceInfo !== void 0 && sourceInfo.title) {
+              _this.updateSourceTitleSubscriptions(existingSyncBlock.resourceId, sourceInfo.title);
+            }
           }
         }).finally(function () {
           _this.syncBlockURLRequests.set(resourceId, false);
@@ -163,7 +168,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
             case 7:
               resolvedData = [];
               data.forEach(function (syncBlockInstance) {
-                var _resolvedSyncBlockIns;
+                var _resolvedSyncBlockIns, _resolvedSyncBlockIns2;
                 if (!syncBlockInstance.resourceId) {
                   return;
                 }
@@ -172,9 +177,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
                 _this2.updateCache(resolvedSyncBlockInstance);
                 resolvedData.push(resolvedSyncBlockInstance);
 
-                // fetch source URL if not already present
-                if (!((_resolvedSyncBlockIns = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns !== void 0 && _resolvedSyncBlockIns.sourceURL) && resolvedSyncBlockInstance.resourceId) {
-                  _this2.fetchSyncBlockSourceURL(resolvedSyncBlockInstance.resourceId);
+                // fetch source URL and title if not already present
+                if ((!((_resolvedSyncBlockIns = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns !== void 0 && _resolvedSyncBlockIns.sourceURL) || !((_resolvedSyncBlockIns2 = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns2 !== void 0 && _resolvedSyncBlockIns2.sourceTitle)) && resolvedSyncBlockInstance.resourceId) {
+                  _this2.fetchSyncBlockSourceURLAndTitle(resolvedSyncBlockInstance.resourceId);
                 }
               });
               return _context3.abrupt("return", resolvedData);
@@ -203,6 +208,16 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
         }
       }
     }
+  }, {
+    key: "updateSourceTitleSubscriptions",
+    value: function updateSourceTitleSubscriptions(resourceId, title) {
+      var callbacks = this.titleSubscriptions.get(resourceId);
+      if (callbacks) {
+        Object.values(callbacks).forEach(function (callback) {
+          callback(title);
+        });
+      }
+    }
   }, {
     key: "getFromCache",
     value: function getFromCache(resourceId) {
@@ -252,6 +267,41 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
         }
       };
     }
+  }, {
+    key: "subscribeToSourceTitle",
+    value: function subscribeToSourceTitle(node, callback) {
+      var _cachedData$data,
+        _this4 = this;
+      // check node is a sync block, as we only support sync block subscriptions
+      if (node.type.name !== 'syncBlock') {
+        return function () {};
+      }
+      var _node$attrs2 = node.attrs,
+        resourceId = _node$attrs2.resourceId,
+        localId = _node$attrs2.localId;
+      if (!localId || !resourceId) {
+        return function () {};
+      }
+      var cachedData = this.getFromCache(resourceId);
+      if (cachedData !== null && cachedData !== void 0 && (_cachedData$data = cachedData.data) !== null && _cachedData$data !== void 0 && _cachedData$data.sourceTitle) {
+        callback(cachedData.data.sourceTitle);
+      }
+
+      // add to subscriptions map
+      var resourceSubscriptions = this.titleSubscriptions.get(resourceId) || {};
+      this.titleSubscriptions.set(resourceId, _objectSpread(_objectSpread({}, resourceSubscriptions), {}, (0, _defineProperty2.default)({}, localId, callback)));
+      return function () {
+        var resourceSubscriptions = _this4.titleSubscriptions.get(resourceId);
+        if (resourceSubscriptions) {
+          delete resourceSubscriptions[localId];
+          if (Object.keys(resourceSubscriptions).length === 0) {
+            _this4.titleSubscriptions.delete(resourceId);
+          } else {
+            _this4.titleSubscriptions.set(resourceId, resourceSubscriptions);
+          }
+        }
+      };
+    }
 
     /**
      * Get the URL for a sync block.

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

@@ -111,6 +111,11 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
     value: function subscribeToSyncBlockData(node, callback) {
       return this.referenceSyncBlockStoreManager.subscribe(node, callback);
     }
+  }, {
+    key: "subscribeToSyncBlockSourceTitle",
+    value: function subscribeToSyncBlockSourceTitle(node, callback) {
+      return this.referenceSyncBlockStoreManager.subscribeToSourceTitle(node, callback);
+    }
   }, {
     key: "refreshSubscriptions",
     value: function refreshSubscriptions() {

package/dist/cjs/utils/resolveSyncBlockInstance.js

@@ -19,7 +19,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
  * @returns A merged SyncBlockInstance object.
  */
 var resolveSyncBlockInstance = exports.resolveSyncBlockInstance = function resolveSyncBlockInstance(oldResult, newResult) {
-  var _newResult$data, _oldResult$data;
+  var _newResult$data, _oldResult$data, _newResult$data2, _oldResult$data2;
   // if the old result has no data, we simple return the new result
   if (!oldResult.data) {
     return newResult;
@@ -29,10 +29,11 @@ var resolveSyncBlockInstance = exports.resolveSyncBlockInstance = function resol
     return oldResult;
   }
 
-  // otherwise, we merge the two results, preserving the sourceURL from the old result if it exists
+  // otherwise, we merge the two results, preserving the sourceURL and sourceTitle from the old result if it exists
   return _objectSpread(_objectSpread({}, newResult), {}, {
     data: _objectSpread(_objectSpread({}, newResult.data), {}, {
-      sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined
+      sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined,
+      sourceTitle: ((_newResult$data2 = newResult.data) === null || _newResult$data2 === void 0 ? void 0 : _newResult$data2.sourceTitle) || ((_oldResult$data2 = oldResult.data) === null || _oldResult$data2 === void 0 ? void 0 : _oldResult$data2.sourceTitle) || undefined
     })
   });
 };

package/dist/es2019/hooks/useFetchSyncBlockTitle.js

@@ -0,0 +1,13 @@
+import { useEffect, useState } from 'react';
+export const useFetchSyncBlockTitle = (manager, syncBlockNode) => {
+  const [sourceTitle, setSourceTitle] = useState(undefined);
+  useEffect(() => {
+    const unsubscribe = manager.subscribeToSyncBlockSourceTitle(syncBlockNode, title => {
+      setSourceTitle(title);
+    });
+    return () => {
+      unsubscribe();
+    };
+  }, [manager, syncBlockNode]);
+  return sourceTitle;
+};

package/dist/es2019/index.js

@@ -3,6 +3,7 @@
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
+export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 export { SyncBlockError } from './common/types';
 export { getDefaultSyncBlockSchema } from './common/schema';

package/dist/es2019/providers/syncBlockProvider.js

@@ -72,7 +72,7 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
   getSourceId() {
     return this.sourceId;
   }
-  retrieveSyncBlockSourceUrl(node) {
+  retrieveSyncBlockSourceUrlAndTitle(node) {
     const {
       resourceId
     } = node.attrs;
@@ -90,7 +90,7 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
         // EDITOR-1921: log analytic here, safe to continue
       }
     }
-    return pageARI ? fetchURLfromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
+    return pageARI ? fetchURLandTitlefromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
   }
 }
 export const useMemoizedSyncedBlockProvider = (fetchProvider, writeProvider, sourceId) => {
@@ -98,7 +98,7 @@ export const useMemoizedSyncedBlockProvider = (fetchProvider, writeProvider, sou
     return new SyncBlockProvider(fetchProvider, writeProvider, sourceId);
   }, [fetchProvider, writeProvider, sourceId]);
 };
-const fetchURLfromARI = async (ari, sourceLocalId) => {
+const fetchURLandTitlefromARI = async (ari, sourceLocalId) => {
   const response = await fetch('/gateway/api/object-resolver/resolve/ari', {
     method: 'POST',
     headers: {
@@ -110,15 +110,17 @@ const fetchURLfromARI = async (ari, sourceLocalId) => {
     })
   });
   if (response.ok) {
-    var _payload$data;
+    var _payload$data, _payload$data2;
     const payload = await response.json();
     const url = payload === null || payload === void 0 ? void 0 : (_payload$data = payload.data) === null || _payload$data === void 0 ? void 0 : _payload$data.url;
-    if (typeof url === 'string') {
-      return sourceLocalId ? url + `?block=${sourceLocalId}` : url;
-    }
+    const title = payload === null || payload === void 0 ? void 0 : (_payload$data2 = payload.data) === null || _payload$data2 === void 0 ? void 0 : _payload$data2.name;
+    return {
+      url: typeof url === 'string' ? sourceLocalId ? url + `?block=${sourceLocalId}` : url : undefined,
+      title: typeof title === 'string' ? title : undefined
+    };
   } else {
     //eslint-disable-next-line no-console
-    console.error('Failed to fetch URL from ARI', response.statusText);
+    console.error('Failed to fetch URL and title from ARI', response.statusText);
   }
   return undefined;
 };

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

@@ -6,6 +6,7 @@ export class ReferenceSyncBlockStoreManager {
     _defineProperty(this, "isRefreshingSubscriptions", false);
     this.syncBlockCache = new Map();
     this.subscriptions = new Map();
+    this.titleSubscriptions = new Map();
     this.dataProvider = dataProvider;
     this.syncBlockURLRequests = new Map();
   }
@@ -35,7 +36,7 @@ export class ReferenceSyncBlockStoreManager {
       this.isRefreshingSubscriptions = false;
     }
   }
-  fetchSyncBlockSourceURL(resourceId) {
+  fetchSyncBlockSourceURLAndTitle(resourceId) {
     if (!resourceId || !this.dataProvider) {
       return;
     }
@@ -44,14 +45,18 @@ export class ReferenceSyncBlockStoreManager {
     // we could optimise this further by checking if the sync block is on the same page as the source
     if (!this.syncBlockURLRequests.get(resourceId)) {
       this.syncBlockURLRequests.set(resourceId, true);
-      this.dataProvider.retrieveSyncBlockSourceUrl(createSyncBlockNode('', resourceId)).then(sourceURL => {
+      this.dataProvider.retrieveSyncBlockSourceUrlAndTitle(createSyncBlockNode('', resourceId)).then(sourceInfo => {
         const existingSyncBlock = this.getFromCache(resourceId);
         if (existingSyncBlock && existingSyncBlock.data) {
           existingSyncBlock.data = {
             ...existingSyncBlock.data,
-            sourceURL
+            sourceURL: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.url,
+            sourceTitle: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.title
           };
           this.updateCache(existingSyncBlock);
+          if (sourceInfo !== null && sourceInfo !== void 0 && sourceInfo.title) {
+            this.updateSourceTitleSubscriptions(existingSyncBlock.resourceId, sourceInfo.title);
+          }
         }
       }).finally(() => {
         this.syncBlockURLRequests.set(resourceId, false);
@@ -68,7 +73,7 @@ export class ReferenceSyncBlockStoreManager {
     }
     const resolvedData = [];
     data.forEach(syncBlockInstance => {
-      var _resolvedSyncBlockIns;
+      var _resolvedSyncBlockIns, _resolvedSyncBlockIns2;
       if (!syncBlockInstance.resourceId) {
         return;
       }
@@ -77,9 +82,9 @@ export class ReferenceSyncBlockStoreManager {
       this.updateCache(resolvedSyncBlockInstance);
       resolvedData.push(resolvedSyncBlockInstance);
 
-      // fetch source URL if not already present
-      if (!((_resolvedSyncBlockIns = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns !== void 0 && _resolvedSyncBlockIns.sourceURL) && resolvedSyncBlockInstance.resourceId) {
-        this.fetchSyncBlockSourceURL(resolvedSyncBlockInstance.resourceId);
+      // fetch source URL and title if not already present
+      if ((!((_resolvedSyncBlockIns = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns !== void 0 && _resolvedSyncBlockIns.sourceURL) || !((_resolvedSyncBlockIns2 = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns2 !== void 0 && _resolvedSyncBlockIns2.sourceTitle)) && resolvedSyncBlockInstance.resourceId) {
+        this.fetchSyncBlockSourceURLAndTitle(resolvedSyncBlockInstance.resourceId);
       }
     });
     return resolvedData;
@@ -98,6 +103,14 @@ export class ReferenceSyncBlockStoreManager {
       }
     }
   }
+  updateSourceTitleSubscriptions(resourceId, title) {
+    const callbacks = this.titleSubscriptions.get(resourceId);
+    if (callbacks) {
+      Object.values(callbacks).forEach(callback => {
+        callback(title);
+      });
+    }
+  }
   getFromCache(resourceId) {
     return this.syncBlockCache.get(resourceId);
   }
@@ -144,6 +157,42 @@ export class ReferenceSyncBlockStoreManager {
       }
     };
   }
+  subscribeToSourceTitle(node, callback) {
+    var _cachedData$data;
+    // check node is a sync block, as we only support sync block subscriptions
+    if (node.type.name !== 'syncBlock') {
+      return () => {};
+    }
+    const {
+      resourceId,
+      localId
+    } = node.attrs;
+    if (!localId || !resourceId) {
+      return () => {};
+    }
+    const cachedData = this.getFromCache(resourceId);
+    if (cachedData !== null && cachedData !== void 0 && (_cachedData$data = cachedData.data) !== null && _cachedData$data !== void 0 && _cachedData$data.sourceTitle) {
+      callback(cachedData.data.sourceTitle);
+    }
+
+    // add to subscriptions map
+    const resourceSubscriptions = this.titleSubscriptions.get(resourceId) || {};
+    this.titleSubscriptions.set(resourceId, {
+      ...resourceSubscriptions,
+      [localId]: callback
+    });
+    return () => {
+      const resourceSubscriptions = this.titleSubscriptions.get(resourceId);
+      if (resourceSubscriptions) {
+        delete resourceSubscriptions[localId];
+        if (Object.keys(resourceSubscriptions).length === 0) {
+          this.titleSubscriptions.delete(resourceId);
+        } else {
+          this.titleSubscriptions.set(resourceId, resourceSubscriptions);
+        }
+      }
+    };
+  }
 
   /**
    * Get the URL for a sync block.

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

@@ -82,6 +82,9 @@ export class SyncBlockStoreManager {
   subscribeToSyncBlockData(node, callback) {
     return this.referenceSyncBlockStoreManager.subscribe(node, callback);
   }
+  subscribeToSyncBlockSourceTitle(node, callback) {
+    return this.referenceSyncBlockStoreManager.subscribeToSourceTitle(node, callback);
+  }
   refreshSubscriptions() {
     this.referenceSyncBlockStoreManager.refreshSubscriptions();
   }

package/dist/es2019/utils/resolveSyncBlockInstance.js

@@ -9,7 +9,7 @@
  * @returns A merged SyncBlockInstance object.
  */
 export const resolveSyncBlockInstance = (oldResult, newResult) => {
-  var _newResult$data, _oldResult$data;
+  var _newResult$data, _oldResult$data, _newResult$data2, _oldResult$data2;
   // if the old result has no data, we simple return the new result
   if (!oldResult.data) {
     return newResult;
@@ -19,12 +19,13 @@ export const resolveSyncBlockInstance = (oldResult, newResult) => {
     return oldResult;
   }
 
-  // otherwise, we merge the two results, preserving the sourceURL from the old result if it exists
+  // otherwise, we merge the two results, preserving the sourceURL and sourceTitle from the old result if it exists
   return {
     ...newResult,
     data: {
       ...newResult.data,
-      sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined
+      sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined,
+      sourceTitle: ((_newResult$data2 = newResult.data) === null || _newResult$data2 === void 0 ? void 0 : _newResult$data2.sourceTitle) || ((_oldResult$data2 = oldResult.data) === null || _oldResult$data2 === void 0 ? void 0 : _oldResult$data2.sourceTitle) || undefined
     }
   };
 };

package/dist/esm/hooks/useFetchSyncBlockTitle.js

@@ -0,0 +1,17 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useEffect, useState } from 'react';
+export var useFetchSyncBlockTitle = function useFetchSyncBlockTitle(manager, syncBlockNode) {
+  var _useState = useState(undefined),
+    _useState2 = _slicedToArray(_useState, 2),
+    sourceTitle = _useState2[0],
+    setSourceTitle = _useState2[1];
+  useEffect(function () {
+    var unsubscribe = manager.subscribeToSyncBlockSourceTitle(syncBlockNode, function (title) {
+      setSourceTitle(title);
+    });
+    return function () {
+      unsubscribe();
+    };
+  }, [manager, syncBlockNode]);
+  return sourceTitle;
+};

package/dist/esm/index.js

@@ -3,6 +3,7 @@
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
+export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 export { SyncBlockError } from './common/types';
 export { getDefaultSyncBlockSchema } from './common/schema';

package/dist/esm/providers/syncBlockProvider.js

@@ -126,8 +126,8 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
       return this.sourceId;
     }
   }, {
-    key: "retrieveSyncBlockSourceUrl",
-    value: function retrieveSyncBlockSourceUrl(node) {
+    key: "retrieveSyncBlockSourceUrlAndTitle",
+    value: function retrieveSyncBlockSourceUrlAndTitle(node) {
       var resourceId = node.attrs.resourceId;
       var pageARI;
       var sourceLocalId;
@@ -143,7 +143,7 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
           // EDITOR-1921: log analytic here, safe to continue
         }
       }
-      return pageARI ? fetchURLfromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
+      return pageARI ? fetchURLandTitlefromARI(pageARI, sourceLocalId) : Promise.resolve(undefined);
     }
   }]);
 }(SyncBlockDataProvider);
@@ -152,9 +152,9 @@ export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvi
     return new SyncBlockProvider(fetchProvider, writeProvider, sourceId);
   }, [fetchProvider, writeProvider, sourceId]);
 };
-var fetchURLfromARI = /*#__PURE__*/function () {
+var fetchURLandTitlefromARI = /*#__PURE__*/function () {
   var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(ari, sourceLocalId) {
-    var response, _payload$data, payload, url;
+    var response, _payload$data, _payload$data2, payload, url, title;
     return _regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
@@ -180,17 +180,14 @@ var fetchURLfromARI = /*#__PURE__*/function () {
         case 6:
           payload = _context2.sent;
           url = payload === null || payload === void 0 || (_payload$data = payload.data) === null || _payload$data === void 0 ? void 0 : _payload$data.url;
-          if (!(typeof url === 'string')) {
-            _context2.next = 10;
-            break;
-          }
-          return _context2.abrupt("return", sourceLocalId ? url + "?block=".concat(sourceLocalId) : url);
-        case 10:
-          _context2.next = 13;
-          break;
+          title = payload === null || payload === void 0 || (_payload$data2 = payload.data) === null || _payload$data2 === void 0 ? void 0 : _payload$data2.name;
+          return _context2.abrupt("return", {
+            url: typeof url === 'string' ? sourceLocalId ? url + "?block=".concat(sourceLocalId) : url : undefined,
+            title: typeof title === 'string' ? title : undefined
+          });
         case 12:
           //eslint-disable-next-line no-console
-          console.error('Failed to fetch URL from ARI', response.statusText);
+          console.error('Failed to fetch URL and title from ARI', response.statusText);
         case 13:
           return _context2.abrupt("return", undefined);
         case 14:
@@ -199,7 +196,7 @@ var fetchURLfromARI = /*#__PURE__*/function () {
       }
     }, _callee2);
   }));
-  return function fetchURLfromARI(_x2, _x3) {
+  return function fetchURLandTitlefromARI(_x2, _x3) {
     return _ref.apply(this, arguments);
   };
 }();

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

@@ -17,6 +17,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     _defineProperty(this, "isRefreshingSubscriptions", false);
     this.syncBlockCache = new Map();
     this.subscriptions = new Map();
+    this.titleSubscriptions = new Map();
     this.dataProvider = dataProvider;
     this.syncBlockURLRequests = new Map();
   }
@@ -105,8 +106,8 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       return refreshSubscriptions;
     }())
   }, {
-    key: "fetchSyncBlockSourceURL",
-    value: function fetchSyncBlockSourceURL(resourceId) {
+    key: "fetchSyncBlockSourceURLAndTitle",
+    value: function fetchSyncBlockSourceURLAndTitle(resourceId) {
       var _this = this;
       if (!resourceId || !this.dataProvider) {
         return;
@@ -116,13 +117,17 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       // we could optimise this further by checking if the sync block is on the same page as the source
       if (!this.syncBlockURLRequests.get(resourceId)) {
         this.syncBlockURLRequests.set(resourceId, true);
-        this.dataProvider.retrieveSyncBlockSourceUrl(createSyncBlockNode('', resourceId)).then(function (sourceURL) {
+        this.dataProvider.retrieveSyncBlockSourceUrlAndTitle(createSyncBlockNode('', resourceId)).then(function (sourceInfo) {
           var existingSyncBlock = _this.getFromCache(resourceId);
           if (existingSyncBlock && existingSyncBlock.data) {
             existingSyncBlock.data = _objectSpread(_objectSpread({}, existingSyncBlock.data), {}, {
-              sourceURL: sourceURL
+              sourceURL: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.url,
+              sourceTitle: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.title
             });
             _this.updateCache(existingSyncBlock);
+            if (sourceInfo !== null && sourceInfo !== void 0 && sourceInfo.title) {
+              _this.updateSourceTitleSubscriptions(existingSyncBlock.resourceId, sourceInfo.title);
+            }
           }
         }).finally(function () {
           _this.syncBlockURLRequests.set(resourceId, false);
@@ -156,7 +161,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
             case 7:
               resolvedData = [];
               data.forEach(function (syncBlockInstance) {
-                var _resolvedSyncBlockIns;
+                var _resolvedSyncBlockIns, _resolvedSyncBlockIns2;
                 if (!syncBlockInstance.resourceId) {
                   return;
                 }
@@ -165,9 +170,9 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
                 _this2.updateCache(resolvedSyncBlockInstance);
                 resolvedData.push(resolvedSyncBlockInstance);
 
-                // fetch source URL if not already present
-                if (!((_resolvedSyncBlockIns = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns !== void 0 && _resolvedSyncBlockIns.sourceURL) && resolvedSyncBlockInstance.resourceId) {
-                  _this2.fetchSyncBlockSourceURL(resolvedSyncBlockInstance.resourceId);
+                // fetch source URL and title if not already present
+                if ((!((_resolvedSyncBlockIns = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns !== void 0 && _resolvedSyncBlockIns.sourceURL) || !((_resolvedSyncBlockIns2 = resolvedSyncBlockInstance.data) !== null && _resolvedSyncBlockIns2 !== void 0 && _resolvedSyncBlockIns2.sourceTitle)) && resolvedSyncBlockInstance.resourceId) {
+                  _this2.fetchSyncBlockSourceURLAndTitle(resolvedSyncBlockInstance.resourceId);
                 }
               });
               return _context3.abrupt("return", resolvedData);
@@ -196,6 +201,16 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
         }
       }
     }
+  }, {
+    key: "updateSourceTitleSubscriptions",
+    value: function updateSourceTitleSubscriptions(resourceId, title) {
+      var callbacks = this.titleSubscriptions.get(resourceId);
+      if (callbacks) {
+        Object.values(callbacks).forEach(function (callback) {
+          callback(title);
+        });
+      }
+    }
   }, {
     key: "getFromCache",
     value: function getFromCache(resourceId) {
@@ -245,6 +260,41 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
         }
       };
     }
+  }, {
+    key: "subscribeToSourceTitle",
+    value: function subscribeToSourceTitle(node, callback) {
+      var _cachedData$data,
+        _this4 = this;
+      // check node is a sync block, as we only support sync block subscriptions
+      if (node.type.name !== 'syncBlock') {
+        return function () {};
+      }
+      var _node$attrs2 = node.attrs,
+        resourceId = _node$attrs2.resourceId,
+        localId = _node$attrs2.localId;
+      if (!localId || !resourceId) {
+        return function () {};
+      }
+      var cachedData = this.getFromCache(resourceId);
+      if (cachedData !== null && cachedData !== void 0 && (_cachedData$data = cachedData.data) !== null && _cachedData$data !== void 0 && _cachedData$data.sourceTitle) {
+        callback(cachedData.data.sourceTitle);
+      }
+
+      // add to subscriptions map
+      var resourceSubscriptions = this.titleSubscriptions.get(resourceId) || {};
+      this.titleSubscriptions.set(resourceId, _objectSpread(_objectSpread({}, resourceSubscriptions), {}, _defineProperty({}, localId, callback)));
+      return function () {
+        var resourceSubscriptions = _this4.titleSubscriptions.get(resourceId);
+        if (resourceSubscriptions) {
+          delete resourceSubscriptions[localId];
+          if (Object.keys(resourceSubscriptions).length === 0) {
+            _this4.titleSubscriptions.delete(resourceId);
+          } else {
+            _this4.titleSubscriptions.set(resourceId, resourceSubscriptions);
+          }
+        }
+      };
+    }
 
     /**
      * Get the URL for a sync block.

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

@@ -105,6 +105,11 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
     value: function subscribeToSyncBlockData(node, callback) {
       return this.referenceSyncBlockStoreManager.subscribe(node, callback);
     }
+  }, {
+    key: "subscribeToSyncBlockSourceTitle",
+    value: function subscribeToSyncBlockSourceTitle(node, callback) {
+      return this.referenceSyncBlockStoreManager.subscribeToSourceTitle(node, callback);
+    }
   }, {
     key: "refreshSubscriptions",
     value: function refreshSubscriptions() {

package/dist/esm/utils/resolveSyncBlockInstance.js

@@ -12,7 +12,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
  * @returns A merged SyncBlockInstance object.
  */
 export var resolveSyncBlockInstance = function resolveSyncBlockInstance(oldResult, newResult) {
-  var _newResult$data, _oldResult$data;
+  var _newResult$data, _oldResult$data, _newResult$data2, _oldResult$data2;
   // if the old result has no data, we simple return the new result
   if (!oldResult.data) {
     return newResult;
@@ -22,10 +22,11 @@ export var resolveSyncBlockInstance = function resolveSyncBlockInstance(oldResul
     return oldResult;
   }
 
-  // otherwise, we merge the two results, preserving the sourceURL from the old result if it exists
+  // otherwise, we merge the two results, preserving the sourceURL and sourceTitle from the old result if it exists
   return _objectSpread(_objectSpread({}, newResult), {}, {
     data: _objectSpread(_objectSpread({}, newResult.data), {}, {
-      sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined
+      sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined,
+      sourceTitle: ((_newResult$data2 = newResult.data) === null || _newResult$data2 === void 0 ? void 0 : _newResult$data2.sourceTitle) || ((_oldResult$data2 = oldResult.data) === null || _oldResult$data2 === void 0 ? void 0 : _oldResult$data2.sourceTitle) || undefined
     })
   });
 };

package/dist/types/common/types.d.ts

@@ -24,6 +24,7 @@ export interface SyncBlockData {
     isSynced?: boolean;
     resourceId: ResourceId;
     sourceDocumentAri?: string;
+    sourceTitle?: string;
     sourceURL?: string;
     updatedAt?: string;
 }

package/dist/types/hooks/useFetchSyncBlockTitle.d.ts

@@ -0,0 +1,3 @@
+import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
+export declare const useFetchSyncBlockTitle: (manager: SyncBlockStoreManager, syncBlockNode: PMNode) => string | undefined;

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
+export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 export type { SyncBlockData, SyncBlockNode } from './common/types';
 export type { SyncBlockDataProvider, ADFFetchProvider, ADFWriteProvider, SyncBlockInstance, } from './providers/types';

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

@@ -1,6 +1,6 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import { type SyncBlockData, type SyncBlockNode } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -20,6 +20,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
-    retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;

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

@@ -15,6 +15,10 @@ export type DeleteSyncBlockResult = {
     resourceId: string;
     success: boolean;
 };
+export type SyncBlockSourceInfo = {
+    title?: string;
+    url?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
@@ -26,6 +30,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<ResourceId | undefined>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
-    abstract retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    abstract retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
+export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -1,10 +1,11 @@
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { ResourceId, SyncBlockNode } from '../common/types';
-import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider } from '../providers/types';
+import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
 export declare class ReferenceSyncBlockStoreManager {
     private dataProvider?;
     private syncBlockCache;
     private subscriptions;
+    private titleSubscriptions;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -13,12 +14,14 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns {Promise<void>}
      */
     refreshSubscriptions(): Promise<void>;
-    private fetchSyncBlockSourceURL;
+    private fetchSyncBlockSourceURLAndTitle;
     fetchSyncBlocksData(syncBlockNodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     private updateCache;
+    private updateSourceTitleSubscriptions;
     private getFromCache;
     private deleteFromCache;
     subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
+    subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
     /**
      * Get the URL for a sync block.
      * @param resourceId - The resource ID of the sync block

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

@@ -2,7 +2,7 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/dist/types/view';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { ResourceId, SyncBlockAttrs, SyncBlockNode } from '../common/types';
-import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance } from '../providers/types';
+import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance, TitleSubscriptionCallback } from '../providers/types';
 import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
@@ -37,6 +37,7 @@ export declare class SyncBlockStoreManager {
     requireConfirmationBeforeDelete(): boolean;
     createSyncBlockNode(): SyncBlockNode;
     subscribeToSyncBlockData(node: PMNode, callback: SubscriptionCallback): () => void;
+    subscribeToSyncBlockSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
     refreshSubscriptions(): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;

package/dist/types-ts4.5/common/types.d.ts

@@ -24,6 +24,7 @@ export interface SyncBlockData {
     isSynced?: boolean;
     resourceId: ResourceId;
     sourceDocumentAri?: string;
+    sourceTitle?: string;
     sourceURL?: string;
     updatedAt?: string;
 }

package/dist/types-ts4.5/hooks/useFetchSyncBlockTitle.d.ts

@@ -0,0 +1,3 @@
+import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
+export declare const useFetchSyncBlockTitle: (manager: SyncBlockStoreManager, syncBlockNode: PMNode) => string | undefined;

package/dist/types-ts4.5/index.d.ts

@@ -1,6 +1,7 @@
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
+export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 export type { SyncBlockData, SyncBlockNode } from './common/types';
 export type { SyncBlockDataProvider, ADFFetchProvider, ADFWriteProvider, SyncBlockInstance, } from './providers/types';

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

@@ -1,6 +1,6 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import { type SyncBlockData, type SyncBlockNode } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -20,6 +20,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
-    retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;

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

@@ -15,6 +15,10 @@ export type DeleteSyncBlockResult = {
     resourceId: string;
     success: boolean;
 };
+export type SyncBlockSourceInfo = {
+    title?: string;
+    url?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
@@ -26,6 +30,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<ResourceId | undefined>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
-    abstract retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    abstract retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
+export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -1,10 +1,11 @@
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { ResourceId, SyncBlockNode } from '../common/types';
-import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider } from '../providers/types';
+import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
 export declare class ReferenceSyncBlockStoreManager {
     private dataProvider?;
     private syncBlockCache;
     private subscriptions;
+    private titleSubscriptions;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -13,12 +14,14 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns {Promise<void>}
      */
     refreshSubscriptions(): Promise<void>;
-    private fetchSyncBlockSourceURL;
+    private fetchSyncBlockSourceURLAndTitle;
     fetchSyncBlocksData(syncBlockNodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     private updateCache;
+    private updateSourceTitleSubscriptions;
     private getFromCache;
     private deleteFromCache;
     subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
+    subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
     /**
      * Get the URL for a sync block.
      * @param resourceId - The resource ID of the sync block

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

@@ -2,7 +2,7 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/dist/types/view';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { ResourceId, SyncBlockAttrs, SyncBlockNode } from '../common/types';
-import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance } from '../providers/types';
+import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance, TitleSubscriptionCallback } from '../providers/types';
 import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
@@ -37,6 +37,7 @@ export declare class SyncBlockStoreManager {
     requireConfirmationBeforeDelete(): boolean;
     createSyncBlockNode(): SyncBlockNode;
     subscribeToSyncBlockData(node: PMNode, callback: SubscriptionCallback): () => void;
+    subscribeToSyncBlockSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
     refreshSubscriptions(): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;

package/package.json

@@ -82,7 +82,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.5.1",
+	"version": "2.5.2",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",