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

package/dist/esm/providers/syncBlockProvider.js

@@ -66,39 +66,63 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
      * @param nodes
      * @param data
      *
-     * @returns the resource ids of the nodes that were written
+     * @returns Array of {resourceId?: string, error?: string}.
+     * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
   }, {
     key: "writeNodesData",
-    value: function writeNodesData(nodes, data) {
-      var _this3 = this;
-      var resourceIds = [];
-      nodes.forEach(function (_node, index) {
-        if (!data[index].content) {
-          resourceIds.push(Promise.reject('No Synced Block content to write'));
-          return;
-        }
-        var resourceId = _this3.writeProvider.writeData(data[index]);
-        resourceIds.push(resourceId);
-      });
-      return Promise.all(resourceIds);
-    }
+    value: (function () {
+      var _writeNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(nodes, data) {
+        var _this3 = this;
+        var results;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              _context.next = 2;
+              return Promise.allSettled(nodes.map(function (_node, index) {
+                if (!data[index].content) {
+                  return Promise.reject('No Synced Block content to write');
+                }
+                return _this3.writeProvider.writeData(data[index]);
+              }));
+            case 2:
+              results = _context.sent;
+              return _context.abrupt("return", results.map(function (result) {
+                if (result.status === 'fulfilled') {
+                  return result.value;
+                } else {
+                  return {
+                    error: result.reason
+                  };
+                }
+              }));
+            case 4:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      function writeNodesData(_x, _x2) {
+        return _writeNodesData.apply(this, arguments);
+      }
+      return writeNodesData;
+    }())
   }, {
     key: "deleteNodesData",
     value: function () {
-      var _deleteNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(resourceIds) {
+      var _deleteNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(resourceIds) {
         var _this4 = this;
         var results;
-        return _regeneratorRuntime.wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
+        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
             case 0:
-              _context.next = 2;
+              _context2.next = 2;
               return Promise.allSettled(resourceIds.map(function (resourceId) {
                 return _this4.writeProvider.deleteData(resourceId);
               }));
             case 2:
-              results = _context.sent;
-              return _context.abrupt("return", results.map(function (result, index) {
+              results = _context2.sent;
+              return _context2.abrupt("return", results.map(function (result, index) {
                 if (result.status === 'fulfilled') {
                   return result.value;
                 } else {
@@ -111,11 +135,11 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
               }));
             case 4:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee);
+        }, _callee2);
       }));
-      function deleteNodesData(_x) {
+      function deleteNodesData(_x3) {
         return _deleteNodesData.apply(this, arguments);
       }
       return deleteNodesData;
@@ -153,12 +177,12 @@ export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvi
   }, [fetchProvider, writeProvider, sourceId]);
 };
 var fetchURLandTitlefromARI = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(ari, sourceLocalId) {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(ari, sourceLocalId) {
     var response, _payload$data, _payload$data2, payload, url, title;
-    return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-      while (1) switch (_context2.prev = _context2.next) {
+    return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
         case 0:
-          _context2.next = 2;
+          _context3.next = 2;
           return fetch('/gateway/api/object-resolver/resolve/ari', {
             method: 'POST',
             headers: {
@@ -170,18 +194,18 @@ var fetchURLandTitlefromARI = /*#__PURE__*/function () {
             })
           });
         case 2:
-          response = _context2.sent;
+          response = _context3.sent;
           if (!response.ok) {
-            _context2.next = 12;
+            _context3.next = 12;
             break;
           }
-          _context2.next = 6;
+          _context3.next = 6;
           return response.json();
         case 6:
-          payload = _context2.sent;
+          payload = _context3.sent;
           url = payload === null || payload === void 0 || (_payload$data = payload.data) === null || _payload$data === void 0 ? void 0 : _payload$data.url;
           title = payload === null || payload === void 0 || (_payload$data2 = payload.data) === null || _payload$data2 === void 0 ? void 0 : _payload$data2.name;
-          return _context2.abrupt("return", {
+          return _context3.abrupt("return", {
             url: typeof url === 'string' ? sourceLocalId ? url + "?block=".concat(sourceLocalId) : url : undefined,
             title: typeof title === 'string' ? title : undefined
           });
@@ -189,14 +213,14 @@ var fetchURLandTitlefromARI = /*#__PURE__*/function () {
           //eslint-disable-next-line no-console
           console.error('Failed to fetch URL and title from ARI', response.statusText);
         case 13:
-          return _context2.abrupt("return", undefined);
+          return _context3.abrupt("return", undefined);
         case 14:
         case "end":
-          return _context2.stop();
+          return _context3.stop();
       }
-    }, _callee2);
+    }, _callee3);
   }));
-  return function fetchURLandTitlefromARI(_x2, _x3) {
+  return function fetchURLandTitlefromARI(_x4, _x5) {
     return _ref.apply(this, arguments);
   };
 }();

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

@@ -9,8 +9,8 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
-import { createSyncBlockNode } from '../utils/createSyncBlock';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
+import { createSyncBlockNode } from '../utils/utils';
 export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
   function ReferenceSyncBlockStoreManager(dataProvider) {
     _classCallCheck(this, ReferenceSyncBlockStoreManager);
@@ -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/sourceSyncBlockStoreManager.js

@@ -5,7 +5,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 import uuid from 'uuid';
 import { rebaseTransaction as _rebaseTransaction } from '../common/rebase-transaction';
 import { resourceIdFromSourceAndLocalId } from '../utils/ari';
-import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
+import { convertSyncBlockPMNodeToSyncBlockData, createBodiedSyncBlockNode as _createBodiedSyncBlockNode } from '../utils/utils';
 export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
   function SourceSyncBlockStoreManager(dataProvider) {
     _classCallCheck(this, SourceSyncBlockStoreManager);
@@ -40,7 +40,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     key: "flushBodiedSyncBlocks",
     value: (function () {
       var _flushBodiedSyncBlocks = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee() {
-        var bodiedSyncBlockNodes, bodiedSyncBlockData, resourceIds;
+        var bodiedSyncBlockNodes, bodiedSyncBlockData, writeResults;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -72,9 +72,9 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               _context.next = 10;
               return this.dataProvider.writeNodesData(bodiedSyncBlockNodes, bodiedSyncBlockData);
             case 10:
-              resourceIds = _context.sent;
-              return _context.abrupt("return", resourceIds.every(function (resourceId) {
-                return resourceId !== undefined;
+              writeResults = _context.sent;
+              return _context.abrupt("return", writeResults.every(function (result) {
+                return result.resourceId !== undefined;
               }));
             case 14:
               _context.prev = 14;
@@ -96,6 +96,35 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function setEditorView(editorView) {
       this.editorView = editorView;
     }
+  }, {
+    key: "registerPendingCreation",
+    value: function registerPendingCreation(resourceId) {
+      this.pendingResourceId = resourceId;
+    }
+  }, {
+    key: "registerCreationCallback",
+    value: function registerCreationCallback(callback) {
+      this.creationCallback = callback;
+    }
+
+    /**
+     *  Fires callback to insert node (if creation is successful) and clears pending creation data
+     * @param success
+     */
+  }, {
+    key: "commitPendingCreation",
+    value: function commitPendingCreation(success) {
+      if (success && this.creationCallback) {
+        this.creationCallback();
+      }
+      this.pendingResourceId = undefined;
+      this.creationCallback = undefined;
+    }
+  }, {
+    key: "hasPendingCreation",
+    value: function hasPendingCreation() {
+      return !!this.pendingResourceId;
+    }
   }, {
     key: "registerConfirmationCallback",
     value: function registerConfirmationCallback(callback) {
@@ -111,31 +140,63 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
       return !!this.confirmationCallback;
     }
   }, {
-    key: "createSyncBlockNode",
-    value: function createSyncBlockNode() {
+    key: "generateBodiedSyncBlockAttrs",
+    value: function generateBodiedSyncBlockAttrs() {
       var _this$dataProvider;
-      var blockInstanceId = uuid();
+      var localId = uuid();
       var sourceId = (_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.getSourceId();
       if (!sourceId) {
         throw new Error('Provider of sync block plugin is not set');
       }
 
       // This should be generated by the data provider implementation as it differs between data providers
-      var resourceId = resourceIdFromSourceAndLocalId(sourceId, blockInstanceId);
-      var syncBlockNode = {
-        attrs: {
-          resourceId: resourceId,
-          localId: blockInstanceId
-        },
-        type: 'bodiedSyncBlock'
+      var resourceId = resourceIdFromSourceAndLocalId(sourceId, localId);
+      return {
+        resourceId: resourceId,
+        localId: localId
       };
-      return syncBlockNode;
+    }
+  }, {
+    key: "createBodiedSyncBlockNode",
+    value: function createBodiedSyncBlockNode(attrs) {
+      var _this2 = this;
+      try {
+        if (!this.dataProvider) {
+          throw new Error('Data provider not set');
+        }
+        var resourceId = attrs.resourceId,
+          blockInstanceId = attrs.localId;
+        this.dataProvider.writeNodesData([_createBodiedSyncBlockNode(blockInstanceId, resourceId)], [{
+          content: [],
+          blockInstanceId: blockInstanceId,
+          resourceId: resourceId
+        }]).then(function (results) {
+          results.forEach(function (result) {
+            var resourceId = result.resourceId;
+            if (resourceId) {
+              _this2.commitPendingCreation(true);
+            } else {
+              _this2.commitPendingCreation(false);
+              // TODO: EDITOR-1921 - add error analytics
+            }
+          });
+        }).catch(function (_reason) {
+          _this2.commitPendingCreation(false);
+          // TODO: EDITOR-1921 - add error analytics
+        });
+        this.registerPendingCreation(resourceId);
+      } catch (error) {
+        if (this.hasPendingCreation()) {
+          this.commitPendingCreation(false);
+        }
+        // TODO: EDITOR-1921 - add error analytics
+      }
     }
   }, {
     key: "deleteSyncBlocksWithConfirmation",
     value: function () {
       var _deleteSyncBlocksWithConfirmation = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(tr, syncBlockIds) {
-        var _this2 = this;
+        var _this3 = this;
         var confirmed, _this$editorView, results;
         return _regeneratorRuntime.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
@@ -170,7 +231,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
               results.forEach(function (result) {
                 if (result.success) {
                   // Only delete when it's deleted successfully in backend
-                  _this2.syncBlockCache.delete(result.resourceId);
+                  _this3.syncBlockCache.delete(result.resourceId);
                 } else {
                   // TODO: EDITOR-1921 - add error analytics with result.error
                 }

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

@@ -1,6 +1,6 @@
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
-import { createSyncBlockNode } from '../utils/createSyncBlock';
+import { convertPMNodeToSyncBlockNode } from '../utils/utils';
 import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
 import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 
@@ -24,16 +24,21 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
   return _createClass(SyncBlockStoreManager, [{
     key: "fetchSyncBlocksData",
     value: function fetchSyncBlocksData(nodes) {
-      var syncBlockNodes = nodes.filter(function (node) {
-        return node.type.name === 'syncBlock' && node.attrs.resourceId && node.attrs.localId;
-      }).map(function (node) {
-        return createSyncBlockNode(node.attrs.localId, node.attrs.resourceId);
+      var syncBlockNodes = nodes.map(function (node) {
+        return convertPMNodeToSyncBlockNode(node);
+      }).filter(function (node) {
+        return node !== undefined;
       }) || [];
       if (syncBlockNodes.length === 0) {
         return Promise.resolve([]);
       }
       return this.referenceSyncBlockStoreManager.fetchSyncBlocksData(syncBlockNodes);
     }
+  }, {
+    key: "getReferenceSyncBlockStoreManager",
+    value: function getReferenceSyncBlockStoreManager() {
+      return this.referenceSyncBlockStoreManager;
+    }
 
     /**
      * Add/update a sync block node to/from the local cache
@@ -94,11 +99,44 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
       // only applicable to source sync block, for now (will be refactored further)
       return this.sourceSyncBlockStoreManager.requireConfirmationBeforeDelete();
     }
+
+    /**
+     * Register callback function (which inserts node, handles focus etc) to be used later when creation to backend succeed
+     */
+  }, {
+    key: "registerCreationCallback",
+    value: function registerCreationCallback(callback) {
+      this.sourceSyncBlockStoreManager.registerCreationCallback(callback);
+    }
+
+    /**
+     *
+     * @returns true if waiting for the result of saving new bodiedSyncBlock to backend
+     */
+  }, {
+    key: "hasPendingCreation",
+    value: function hasPendingCreation() {
+      return this.sourceSyncBlockStoreManager.hasPendingCreation();
+    }
+
+    /**
+     * @returns attributes for a new bodiedSyncBlock node
+     */
+  }, {
+    key: "generateBodiedSyncBlockAttrs",
+    value: function generateBodiedSyncBlockAttrs() {
+      return this.sourceSyncBlockStoreManager.generateBodiedSyncBlockAttrs();
+    }
+
+    /**
+     * Save bodiedSyncBlock with empty content to backend
+     * @param attrs attributes Ids of the node
+     */
   }, {
-    key: "createSyncBlockNode",
-    value: function createSyncBlockNode() {
+    key: "createBodiedSyncBlockNode",
+    value: function createBodiedSyncBlockNode(attrs) {
       // only applicable to source sync block, for now (will be refactored further)
-      return this.sourceSyncBlockStoreManager.createSyncBlockNode();
+      return this.sourceSyncBlockStoreManager.createBodiedSyncBlockNode(attrs);
     }
   }, {
     key: "subscribeToSyncBlockData",

package/dist/esm/utils/errorHandling.js

@@ -0,0 +1,7 @@
+export var stringifyError = function stringifyError(error) {
+  try {
+    return JSON.stringify(error);
+  } catch (_unused) {
+    return undefined;
+  }
+};

package/dist/esm/utils/utils.js

@@ -7,4 +7,35 @@ export var convertSyncBlockPMNodeToSyncBlockData = function convertSyncBlockPMNo
 };
 export var isBlogPageType = function isBlogPageType(pageType) {
   return pageType === 'blogpost';
+};
+export var createSyncBlockNode = function createSyncBlockNode(localId, resourceId) {
+  return {
+    type: 'syncBlock',
+    attrs: {
+      localId: localId,
+      resourceId: resourceId
+    }
+  };
+};
+export var createBodiedSyncBlockNode = function createBodiedSyncBlockNode(localId, resourceId) {
+  return {
+    type: 'bodiedSyncBlock',
+    attrs: {
+      localId: localId,
+      resourceId: resourceId
+    }
+  };
+};
+export var convertSyncBlockJSONNodeToSyncBlockNode = function convertSyncBlockJSONNodeToSyncBlockNode(node) {
+  if (node.type !== 'syncBlock' || !node.attrs || !('localId' in node.attrs) || !('resourceId' in node.attrs) || typeof node.attrs.localId !== 'string' || typeof node.attrs.resourceId !== 'string') {
+    return undefined;
+  }
+  return createSyncBlockNode(node.attrs.localId, node.attrs.resourceId);
+};
+export var convertPMNodeToSyncBlockNode = function convertPMNodeToSyncBlockNode(node) {
+  var _node$attrs, _node$attrs2;
+  if (node.type.name !== 'syncBlock' || !((_node$attrs = node.attrs) !== null && _node$attrs !== void 0 && _node$attrs.localId) || !((_node$attrs2 = node.attrs) !== null && _node$attrs2 !== void 0 && _node$attrs2.resourceId) || typeof node.attrs.localId !== 'string' || typeof node.attrs.resourceId !== 'string') {
+    return undefined;
+  }
+  return createSyncBlockNode(node.attrs.localId, node.attrs.resourceId);
 };

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,15 @@
-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, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

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

@@ -1,5 +1,5 @@
 import { type SyncBlockData } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance } from '../types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -22,7 +22,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     private config;
     constructor(config: ContentAPIConfig);
     private createNewContentProperty;
-    writeData(data: SyncBlockData): Promise<string>;
+    writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
 }
 /**

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, type SyncBlockSourceInfo } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -15,9 +15,10 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @param nodes
      * @param data
      *
-     * @returns the resource ids of the nodes that were written
+     * @returns Array of {resourceId?: string, error?: string}.
+     * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
-    writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
+    writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
     retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;

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

@@ -19,15 +19,19 @@ export type SyncBlockSourceInfo = {
     title?: string;
     url?: string;
 };
+export type WriteSyncBlockResult = {
+    error?: string;
+    resourceId?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
 export interface ADFWriteProvider {
     deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
-    writeData: (data: SyncBlockData) => Promise<string>;
+    writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
-    abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<ResourceId | undefined>>;
+    abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;

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