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

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.6.0
+
+### Minor Changes
+
+- [`261fa27c56fd0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/261fa27c56fd0) -
+  EDITOR-2533 implement retry function for sync-block renderer
+
 ## 2.5.2
 
 ### Patch Changes

package/dist/cjs/hooks/useFetchSyncBlockData.js

@@ -4,22 +4,76 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useFetchSyncBlockData = exports.SYNC_BLOCK_FETCH_INTERVAL = void 0;
+exports.useFetchSyncBlockData = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _react = require("react");
-var SYNC_BLOCK_FETCH_INTERVAL = exports.SYNC_BLOCK_FETCH_INTERVAL = 3000;
-var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyncBlockData(manager, syncBlockNode) {
+var _types = require("../common/types");
+var _createSyncBlock = require("../utils/createSyncBlock");
+var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId) {
   var _useState = (0, _react.useState)(null),
     _useState2 = (0, _slicedToArray2.default)(_useState, 2),
     syncBlockInstance = _useState2[0],
     setSyncBlockInstance = _useState2[1];
+  var _useState3 = (0, _react.useState)(true),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    isLoading = _useState4[0],
+    setIsLoading = _useState4[1];
+  var referenceSyncBlockStoreManager = manager.getReferenceSyncBlockStoreManager();
+  var reloadData = (0, _react.useCallback)( /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+    var syncBlockNode;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          if (!isLoading) {
+            _context.next = 2;
+            break;
+          }
+          return _context.abrupt("return");
+        case 2:
+          syncBlockNode = resourceId && localId ? (0, _createSyncBlock.createSyncBlockNode)(localId, resourceId) : null;
+          if (syncBlockNode) {
+            _context.next = 5;
+            break;
+          }
+          return _context.abrupt("return");
+        case 5:
+          setIsLoading(true);
+          _context.prev = 6;
+          _context.next = 9;
+          return referenceSyncBlockStoreManager.fetchSyncBlocksData([syncBlockNode]);
+        case 9:
+          _context.next = 14;
+          break;
+        case 11:
+          _context.prev = 11;
+          _context.t0 = _context["catch"](6);
+          // Set error state if fetching fails
+          setSyncBlockInstance({
+            resourceId: resourceId || '',
+            error: _types.SyncBlockError.Errored
+          });
+        case 14:
+          setIsLoading(false);
+        case 15:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[6, 11]]);
+  })), [isLoading, localId, referenceSyncBlockStoreManager, resourceId]);
   (0, _react.useEffect)(function () {
-    var unsubscribe = manager.subscribeToSyncBlockData(syncBlockNode, function (data) {
+    var unsubscribe = referenceSyncBlockStoreManager.subscribeToSyncBlock(resourceId || '', localId || '', function (data) {
       setSyncBlockInstance(data);
+      setIsLoading(false);
     });
     return function () {
       unsubscribe();
     };
-  }, [manager, syncBlockNode]);
-  return syncBlockInstance;
+  }, [localId, referenceSyncBlockStoreManager, resourceId]);
+  return {
+    syncBlockInstance: syncBlockInstance,
+    isLoading: isLoading,
+    reloadData: reloadData
+  };
 };

package/dist/cjs/index.js

@@ -3,6 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "ReferenceSyncBlockStoreManager", {
+  enumerable: true,
+  get: function get() {
+    return _referenceSyncBlockStoreManager.ReferenceSyncBlockStoreManager;
+  }
+});
 Object.defineProperty(exports, "SyncBlockError", {
   enumerable: true,
   get: function get() {
@@ -33,6 +39,12 @@ Object.defineProperty(exports, "createContentAPIProvidersWithDefaultKey", {
     return _confluenceContentAPI.createContentAPIProvidersWithDefaultKey;
   }
 });
+Object.defineProperty(exports, "createSyncBlockNode", {
+  enumerable: true,
+  get: function get() {
+    return _createSyncBlock.createSyncBlockNode;
+  }
+});
 Object.defineProperty(exports, "getConfluencePageAri", {
   enumerable: true,
   get: function get() {
@@ -93,15 +105,17 @@ Object.defineProperty(exports, "useMemoizedSyncedBlockProvider", {
     return _syncBlockProvider.useMemoizedSyncedBlockProvider;
   }
 });
-var _syncBlockProvider = require("./providers/syncBlockProvider");
-var _syncBlockStoreManager = require("./store-manager/syncBlockStoreManager");
+var _rebaseTransaction = require("./common/rebase-transaction");
+var _schema = require("./common/schema");
+var _types = require("./common/types");
 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");
 var _confluenceContentAPI = require("./providers/confluence/confluenceContentAPI");
+var _syncBlockProvider = require("./providers/syncBlockProvider");
+var _referenceSyncBlockStoreManager = require("./store-manager/referenceSyncBlockStoreManager");
+var _syncBlockStoreManager = require("./store-manager/syncBlockStoreManager");
 var _ari = require("./utils/ari");
-var _utils = require("./utils/utils");
-var _rebaseTransaction = require("./common/rebase-transaction");
-var _resolveSyncBlockInstance = require("./utils/resolveSyncBlockInstance");
+var _createSyncBlock = require("./utils/createSyncBlock");
+var _resolveSyncBlockInstance = require("./utils/resolveSyncBlockInstance");
+var _utils = require("./utils/utils");

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

@@ -229,20 +229,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       this.syncBlockCache.delete(resourceId);
     }
   }, {
-    key: "subscribe",
-    value: function subscribe(node, callback) {
+    key: "subscribeToSyncBlock",
+    value: function subscribeToSyncBlock(resourceId, localId, callback) {
       var _this3 = this;
-      // check node is a sync block, as we only support sync block subscriptions
-      if (node.type.name !== 'syncBlock') {
-        return function () {};
-      }
-      var _node$attrs = node.attrs,
-        resourceId = _node$attrs.resourceId,
-        localId = _node$attrs.localId;
-      if (!localId || !resourceId) {
-        return function () {};
-      }
-
       // add to subscriptions map
       var resourceSubscriptions = this.subscriptions.get(resourceId) || {};
       this.subscriptions.set(resourceId, _objectSpread(_objectSpread({}, resourceSubscriptions), {}, (0, _defineProperty2.default)({}, localId, callback)));
@@ -276,9 +265,9 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       if (node.type.name !== 'syncBlock') {
         return function () {};
       }
-      var _node$attrs2 = node.attrs,
-        resourceId = _node$attrs2.resourceId,
-        localId = _node$attrs2.localId;
+      var _node$attrs = node.attrs,
+        resourceId = _node$attrs.resourceId,
+        localId = _node$attrs.localId;
       if (!localId || !resourceId) {
         return function () {};
       }
@@ -302,6 +291,21 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
         }
       };
     }
+  }, {
+    key: "subscribe",
+    value: function subscribe(node, callback) {
+      // 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 () {};
+      }
+      return this.subscribeToSyncBlock(resourceId, localId, callback);
+    }
 
     /**
      * Get the URL for a sync block.

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

@@ -40,6 +40,11 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
       }
       return this.referenceSyncBlockStoreManager.fetchSyncBlocksData(syncBlockNodes);
     }
+  }, {
+    key: "getReferenceSyncBlockStoreManager",
+    value: function getReferenceSyncBlockStoreManager() {
+      return this.referenceSyncBlockStoreManager;
+    }
 
     /**
      * Add/update a sync block node to/from the local cache

package/dist/es2019/hooks/useFetchSyncBlockData.js

@@ -1,14 +1,43 @@
-import { useEffect, useState } from 'react';
-export const SYNC_BLOCK_FETCH_INTERVAL = 3000;
-export const useFetchSyncBlockData = (manager, syncBlockNode) => {
+import { useCallback, useEffect, useState } from 'react';
+import { SyncBlockError } from '../common/types';
+import { createSyncBlockNode } from '../utils/createSyncBlock';
+export const useFetchSyncBlockData = (manager, resourceId, localId) => {
   const [syncBlockInstance, setSyncBlockInstance] = useState(null);
+  const [isLoading, setIsLoading] = useState(true);
+  const referenceSyncBlockStoreManager = manager.getReferenceSyncBlockStoreManager();
+  const reloadData = useCallback(async () => {
+    if (isLoading) {
+      return;
+    }
+    const syncBlockNode = resourceId && localId ? createSyncBlockNode(localId, resourceId) : null;
+    if (!syncBlockNode) {
+      return;
+    }
+    setIsLoading(true);
+    try {
+      // Fetch sync block data, the `subscribeToSyncBlock` will update the state once data is fetched
+      await referenceSyncBlockStoreManager.fetchSyncBlocksData([syncBlockNode]);
+    } catch (error) {
+      // Set error state if fetching fails
+      setSyncBlockInstance({
+        resourceId: resourceId || '',
+        error: SyncBlockError.Errored
+      });
+    }
+    setIsLoading(false);
+  }, [isLoading, localId, referenceSyncBlockStoreManager, resourceId]);
   useEffect(() => {
-    const unsubscribe = manager.subscribeToSyncBlockData(syncBlockNode, data => {
+    const unsubscribe = referenceSyncBlockStoreManager.subscribeToSyncBlock(resourceId || '', localId || '', data => {
       setSyncBlockInstance(data);
+      setIsLoading(false);
     });
     return () => {
       unsubscribe();
     };
-  }, [manager, syncBlockNode]);
-  return syncBlockInstance;
+  }, [localId, referenceSyncBlockStoreManager, resourceId]);
+  return {
+    syncBlockInstance,
+    isLoading,
+    reloadData
+  };
 };

package/dist/es2019/index.js

@@ -1,14 +1,16 @@
 /* eslint-disable @atlaskit/editor/no-re-export */
 
-export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
-export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
+export { rebaseTransaction } from './common/rebase-transaction';
+export { getDefaultSyncBlockSchema } from './common/schema';
+export { SyncBlockError } from './common/types';
 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';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders } from './providers/confluence/confluenceContentAPI';
+export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
+export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
+export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
-export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';
-export { rebaseTransaction } from './common/rebase-transaction';
-export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { createSyncBlockNode } from './utils/createSyncBlock';
+export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';

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

@@ -117,19 +117,7 @@ export class ReferenceSyncBlockStoreManager {
   deleteFromCache(resourceId) {
     this.syncBlockCache.delete(resourceId);
   }
-  subscribe(node, callback) {
-    // 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 () => {};
-    }
-
+  subscribeToSyncBlock(resourceId, localId, callback) {
     // add to subscriptions map
     const resourceSubscriptions = this.subscriptions.get(resourceId) || {};
     this.subscriptions.set(resourceId, {
@@ -193,6 +181,20 @@ export class ReferenceSyncBlockStoreManager {
       }
     };
   }
+  subscribe(node, callback) {
+    // 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 () => {};
+    }
+    return this.subscribeToSyncBlock(resourceId, localId, callback);
+  }
 
   /**
    * Get the URL for a sync block.

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

@@ -29,6 +29,9 @@ export class SyncBlockStoreManager {
     }
     return this.referenceSyncBlockStoreManager.fetchSyncBlocksData(syncBlockNodes);
   }
+  getReferenceSyncBlockStoreManager() {
+    return this.referenceSyncBlockStoreManager;
+  }
 
   /**
    * Add/update a sync block node to/from the local cache

package/dist/esm/hooks/useFetchSyncBlockData.js

@@ -1,18 +1,72 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-import { useEffect, useState } from 'react';
-export var SYNC_BLOCK_FETCH_INTERVAL = 3000;
-export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, syncBlockNode) {
+import _regeneratorRuntime from "@babel/runtime/regenerator";
+import { useCallback, useEffect, useState } from 'react';
+import { SyncBlockError } from '../common/types';
+import { createSyncBlockNode } from '../utils/createSyncBlock';
+export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, resourceId, localId) {
   var _useState = useState(null),
     _useState2 = _slicedToArray(_useState, 2),
     syncBlockInstance = _useState2[0],
     setSyncBlockInstance = _useState2[1];
+  var _useState3 = useState(true),
+    _useState4 = _slicedToArray(_useState3, 2),
+    isLoading = _useState4[0],
+    setIsLoading = _useState4[1];
+  var referenceSyncBlockStoreManager = manager.getReferenceSyncBlockStoreManager();
+  var reloadData = useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
+    var syncBlockNode;
+    return _regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) switch (_context.prev = _context.next) {
+        case 0:
+          if (!isLoading) {
+            _context.next = 2;
+            break;
+          }
+          return _context.abrupt("return");
+        case 2:
+          syncBlockNode = resourceId && localId ? createSyncBlockNode(localId, resourceId) : null;
+          if (syncBlockNode) {
+            _context.next = 5;
+            break;
+          }
+          return _context.abrupt("return");
+        case 5:
+          setIsLoading(true);
+          _context.prev = 6;
+          _context.next = 9;
+          return referenceSyncBlockStoreManager.fetchSyncBlocksData([syncBlockNode]);
+        case 9:
+          _context.next = 14;
+          break;
+        case 11:
+          _context.prev = 11;
+          _context.t0 = _context["catch"](6);
+          // Set error state if fetching fails
+          setSyncBlockInstance({
+            resourceId: resourceId || '',
+            error: SyncBlockError.Errored
+          });
+        case 14:
+          setIsLoading(false);
+        case 15:
+        case "end":
+          return _context.stop();
+      }
+    }, _callee, null, [[6, 11]]);
+  })), [isLoading, localId, referenceSyncBlockStoreManager, resourceId]);
   useEffect(function () {
-    var unsubscribe = manager.subscribeToSyncBlockData(syncBlockNode, function (data) {
+    var unsubscribe = referenceSyncBlockStoreManager.subscribeToSyncBlock(resourceId || '', localId || '', function (data) {
       setSyncBlockInstance(data);
+      setIsLoading(false);
     });
     return function () {
       unsubscribe();
     };
-  }, [manager, syncBlockNode]);
-  return syncBlockInstance;
+  }, [localId, referenceSyncBlockStoreManager, resourceId]);
+  return {
+    syncBlockInstance: syncBlockInstance,
+    isLoading: isLoading,
+    reloadData: reloadData
+  };
 };

package/dist/esm/index.js

@@ -1,14 +1,16 @@
 /* eslint-disable @atlaskit/editor/no-re-export */
 
-export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
-export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
+export { rebaseTransaction } from './common/rebase-transaction';
+export { getDefaultSyncBlockSchema } from './common/schema';
+export { SyncBlockError } from './common/types';
 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';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders } from './providers/confluence/confluenceContentAPI';
+export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider } from './providers/syncBlockProvider';
+export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
+export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
-export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';
-export { rebaseTransaction } from './common/rebase-transaction';
-export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { createSyncBlockNode } from './utils/createSyncBlock';
+export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';

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

@@ -222,20 +222,9 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       this.syncBlockCache.delete(resourceId);
     }
   }, {
-    key: "subscribe",
-    value: function subscribe(node, callback) {
+    key: "subscribeToSyncBlock",
+    value: function subscribeToSyncBlock(resourceId, localId, callback) {
       var _this3 = this;
-      // check node is a sync block, as we only support sync block subscriptions
-      if (node.type.name !== 'syncBlock') {
-        return function () {};
-      }
-      var _node$attrs = node.attrs,
-        resourceId = _node$attrs.resourceId,
-        localId = _node$attrs.localId;
-      if (!localId || !resourceId) {
-        return function () {};
-      }
-
       // add to subscriptions map
       var resourceSubscriptions = this.subscriptions.get(resourceId) || {};
       this.subscriptions.set(resourceId, _objectSpread(_objectSpread({}, resourceSubscriptions), {}, _defineProperty({}, localId, callback)));
@@ -269,9 +258,9 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       if (node.type.name !== 'syncBlock') {
         return function () {};
       }
-      var _node$attrs2 = node.attrs,
-        resourceId = _node$attrs2.resourceId,
-        localId = _node$attrs2.localId;
+      var _node$attrs = node.attrs,
+        resourceId = _node$attrs.resourceId,
+        localId = _node$attrs.localId;
       if (!localId || !resourceId) {
         return function () {};
       }
@@ -295,6 +284,21 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
         }
       };
     }
+  }, {
+    key: "subscribe",
+    value: function subscribe(node, callback) {
+      // 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 () {};
+      }
+      return this.subscribeToSyncBlock(resourceId, localId, callback);
+    }
 
     /**
      * Get the URL for a sync block.

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

@@ -34,6 +34,11 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
       }
       return this.referenceSyncBlockStoreManager.fetchSyncBlocksData(syncBlockNodes);
     }
+  }, {
+    key: "getReferenceSyncBlockStoreManager",
+    value: function getReferenceSyncBlockStoreManager() {
+      return this.referenceSyncBlockStoreManager;
+    }
 
     /**
      * Add/update a sync block node to/from the local cache

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

@@ -3,4 +3,4 @@
  * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
  * @returns
  */
-export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"status" | "doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;
+export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "status" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;

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

@@ -1,5 +1,8 @@
-import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockInstance } from '../providers/types';
 import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
-export declare const SYNC_BLOCK_FETCH_INTERVAL = 3000;
-export declare const useFetchSyncBlockData: (manager: SyncBlockStoreManager, syncBlockNode: PMNode) => SyncBlockInstance | null;
+export interface UseFetchSyncBlockDataResult {
+    isLoading: boolean;
+    reloadData: () => Promise<void>;
+    syncBlockInstance: SyncBlockInstance | null;
+}
+export declare const useFetchSyncBlockData: (manager: SyncBlockStoreManager, resourceId?: string, localId?: string) => UseFetchSyncBlockDataResult;

package/dist/types/index.d.ts

@@ -1,14 +1,16 @@
-export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
-export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
+export { rebaseTransaction } from './common/rebase-transaction';
+export { getDefaultSyncBlockSchema } from './common/schema';
+export { SyncBlockError } from './common/types';
+export type { SyncBlockData, SyncBlockNode } from './common/types';
+export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } 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';
-export { SyncBlockError } from './common/types';
-export { getDefaultSyncBlockSchema } from './common/schema';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
+export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
+export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
+export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
+export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
-export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';
-export { rebaseTransaction } from './common/rebase-transaction';
+export { createSyncBlockNode } from './utils/createSyncBlock';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';

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

@@ -20,8 +20,9 @@ export declare class ReferenceSyncBlockStoreManager {
     private updateSourceTitleSubscriptions;
     private getFromCache;
     private deleteFromCache;
-    subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
+    subscribeToSyncBlock(resourceId: string, localId: string, callback: SubscriptionCallback): () => void;
     subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
+    subscribe(node: PMNode, callback: SubscriptionCallback): () => 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

@@ -3,6 +3,7 @@ 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, TitleSubscriptionCallback } from '../providers/types';
+import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
 import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
@@ -14,6 +15,7 @@ export declare class SyncBlockStoreManager {
      * @returns The fetched sync block data results
      */
     fetchSyncBlocksData(nodes: PMNode[]): Promise<SyncBlockInstance[]>;
+    getReferenceSyncBlockStoreManager(): ReferenceSyncBlockStoreManager;
     /**
      * Add/update a sync block node to/from the local cache
      * @param syncBlockNode - The sync block node to update

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

@@ -3,4 +3,4 @@
  * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
  * @returns
  */
-export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"status" | "doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;
+export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "status" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;

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

@@ -1,5 +1,8 @@
-import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockInstance } from '../providers/types';
 import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
-export declare const SYNC_BLOCK_FETCH_INTERVAL = 3000;
-export declare const useFetchSyncBlockData: (manager: SyncBlockStoreManager, syncBlockNode: PMNode) => SyncBlockInstance | null;
+export interface UseFetchSyncBlockDataResult {
+    isLoading: boolean;
+    reloadData: () => Promise<void>;
+    syncBlockInstance: SyncBlockInstance | null;
+}
+export declare const useFetchSyncBlockData: (manager: SyncBlockStoreManager, resourceId?: string, localId?: string) => UseFetchSyncBlockDataResult;

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

@@ -1,14 +1,16 @@
-export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
-export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
+export { rebaseTransaction } from './common/rebase-transaction';
+export { getDefaultSyncBlockSchema } from './common/schema';
+export { SyncBlockError } from './common/types';
+export type { SyncBlockData, SyncBlockNode } from './common/types';
+export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } 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';
-export { SyncBlockError } from './common/types';
-export { getDefaultSyncBlockSchema } from './common/schema';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
+export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
+export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
+export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
+export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
 export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
-export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';
-export { rebaseTransaction } from './common/rebase-transaction';
+export { createSyncBlockNode } from './utils/createSyncBlock';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';

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

@@ -20,8 +20,9 @@ export declare class ReferenceSyncBlockStoreManager {
     private updateSourceTitleSubscriptions;
     private getFromCache;
     private deleteFromCache;
-    subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
+    subscribeToSyncBlock(resourceId: string, localId: string, callback: SubscriptionCallback): () => void;
     subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
+    subscribe(node: PMNode, callback: SubscriptionCallback): () => 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

@@ -3,6 +3,7 @@ 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, TitleSubscriptionCallback } from '../providers/types';
+import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
 import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
@@ -14,6 +15,7 @@ export declare class SyncBlockStoreManager {
      * @returns The fetched sync block data results
      */
     fetchSyncBlocksData(nodes: PMNode[]): Promise<SyncBlockInstance[]>;
+    getReferenceSyncBlockStoreManager(): ReferenceSyncBlockStoreManager;
     /**
      * Add/update a sync block node to/from the local cache
      * @param syncBlockNode - The sync block node to update

package/package.json

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