@atlaskit/editor-synced-block-provider 2.9.0 → 2.9.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.9.1
+
+### Patch Changes
+
+- [`e3aafa008fcf4`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e3aafa008fcf4) -
+  EDITOR-2771 Pass parent Editor/Renderer data providers through SyncBlockDataProvider to the nested
+  renderer
+- Updated dependencies
+
 ## 2.9.0
 
 ### Minor Changes

package/dist/cjs/hooks/useFetchSyncBlockData.js

@@ -72,8 +72,9 @@ var useFetchSyncBlockData = exports.useFetchSyncBlockData = function useFetchSyn
     };
   }, [localId, referenceSyncBlockStoreManager, resourceId]);
   return {
-    syncBlockInstance: syncBlockInstance,
     isLoading: isLoading,
-    reloadData: reloadData
+    providerFactory: referenceSyncBlockStoreManager.getProviderFactory(resourceId || ''),
+    reloadData: reloadData,
+    syncBlockInstance: syncBlockInstance
   };
 };

package/dist/cjs/providers/syncBlockProvider.js

@@ -22,7 +22,15 @@ var _sourceInfo = require("../utils/sourceInfo");
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
-  function SyncBlockProvider(fetchProvider, writeProvider, sourceId) {
+  /**
+   * Constructor for the SyncBlockProvider
+   *
+   * @param fetchProvider
+   * @param writeProvider
+   * @param sourceId
+   * @param nestedRendererDataProviders
+   */
+  function SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions) {
     var _this;
     (0, _classCallCheck2.default)(this, SyncBlockProvider);
     _this = _callSuper(this, SyncBlockProvider);
@@ -30,19 +38,44 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     _this.fetchProvider = fetchProvider;
     _this.writeProvider = writeProvider;
     _this.sourceId = sourceId;
+    _this.providerOptions = providerOptions;
     return _this;
   }
+
+  /**
+   * Check if the node is supported by the provider
+   *
+   * @param node
+   *
+   * @returns True if the node is supported, false otherwise
+   */
   (0, _inherits2.default)(SyncBlockProvider, _SyncBlockDataProvide);
   return (0, _createClass2.default)(SyncBlockProvider, [{
     key: "isNodeSupported",
     value: function isNodeSupported(node) {
-      return node.type === 'syncBlock';
+      return node.type === 'syncBlock' || node.type === 'bodiedSyncBlock';
     }
+
+    /**
+     * Get the data key for the node
+     *
+     * @param node
+     *
+     * @returns The data key
+     */
   }, {
     key: "nodeDataKey",
     value: function nodeDataKey(node) {
       return node.attrs.localId;
     }
+
+    /**
+     * Fetch the data from the fetch provider
+     *
+     * @param nodes
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
   }, {
     key: "fetchNodesData",
     value: function fetchNodesData(nodes) {
@@ -70,6 +103,7 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     }
 
     /**
+     * Write the data to the write provider
      *
      * @param nodes
      * @param data
@@ -114,10 +148,18 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
         return _writeNodesData.apply(this, arguments);
       }
       return writeNodesData;
-    }())
+    }()
+    /**
+     * Delete the data from the write provider
+     *
+     * @param resourceIds
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
+    )
   }, {
     key: "deleteNodesData",
-    value: function () {
+    value: (function () {
       var _deleteNodesData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(resourceIds) {
         var _this4 = this;
         var results;
@@ -152,11 +194,25 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
       }
       return deleteNodesData;
     }()
+    /**
+     * Get the source id
+     *
+     * @returns The source id
+     */
+    )
   }, {
     key: "getSourceId",
     value: function getSourceId() {
       return this.sourceId;
     }
+
+    /**
+     * Retrieve the source info from the source id
+     *
+     * @param node
+     *
+     * @returns The source info
+     */
   }, {
     key: "retrieveSyncBlockSourceInfo",
     value: function retrieveSyncBlockSourceInfo(node) {
@@ -182,10 +238,21 @@ var SyncBlockProvider = exports.SyncBlockProvider = /*#__PURE__*/function (_Sync
     value: function generateResourceId(sourceId, localId) {
       return this.writeProvider.generateResourceId(sourceId, localId);
     }
+
+    /**
+     * Get the synced block renderer provider options
+     *
+     * @returns The synced block renderer provider options
+     */
+  }, {
+    key: "getSyncedBlockRendererProviderOptions",
+    value: function getSyncedBlockRendererProviderOptions() {
+      return this.providerOptions;
+    }
   }]);
 }(_types2.SyncBlockDataProvider);
-var useMemoizedSyncedBlockProvider = exports.useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId) {
+var useMemoizedSyncedBlockProvider = exports.useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions) {
   return (0, _react.useMemo)(function () {
-    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId);
-  }, [fetchProvider, writeProvider, sourceId]);
+    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
+  }, [fetchProvider, writeProvider, sourceId, providerOptions]);
 };

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

@@ -11,6 +11,7 @@ var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _providerFactory = require("@atlaskit/editor-common/provider-factory");
 var _types = require("../common/types");
 var _resolveSyncBlockInstance = require("../utils/resolveSyncBlockInstance");
 var _utils = require("../utils/utils");
@@ -28,6 +29,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     this.titleSubscriptions = new Map();
     this.dataProvider = dataProvider;
     this.syncBlockURLRequests = new Map();
+    this.providerFactories = new Map();
   }
 
   /**
@@ -243,6 +245,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
     key: "deleteFromCache",
     value: function deleteFromCache(resourceId) {
       this.syncBlockCache.delete(resourceId);
+      this.providerFactories.delete(resourceId);
     }
   }, {
     key: "subscribeToSyncBlock",
@@ -338,12 +341,35 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       }
       return (_syncBlock$data = syncBlock.data) === null || _syncBlock$data === void 0 ? void 0 : _syncBlock$data.sourceURL;
     }
+  }, {
+    key: "getProviderFactory",
+    value: function getProviderFactory(resourceId) {
+      if (!this.dataProvider) {
+        return undefined;
+      }
+      var _this$dataProvider$ge = this.dataProvider.getSyncedBlockRendererProviderOptions(),
+        parentDataProviders = _this$dataProvider$ge.parentDataProviders;
+      if (!this.providerFactories.has(resourceId)) {
+        // TODO: EDITOR-2771 - In follow up PR, create media & emoji providers per ref sync block
+        // The media & emoji providers will be set later, once we get ref sync block data with page ID
+        // So we need to keep the reference to the Provider Factory so we can then set media & emoji providers later
+        this.providerFactories.set(resourceId, _providerFactory.ProviderFactory.create({
+          emojiProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.emojiProvider,
+          mediaProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mediaProvider,
+          mentionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mentionProvider,
+          profilecardProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.profilecardProvider,
+          taskDecisionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.taskDecisionProvider
+        }));
+      }
+      return this.providerFactories.get(resourceId);
+    }
   }, {
     key: "destroy",
     value: function destroy() {
       this.syncBlockCache.clear();
       this.subscriptions.clear();
       this.syncBlockURLRequests.clear();
+      this.providerFactories.clear();
     }
   }]);
 }();

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

@@ -171,6 +171,11 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
       // only applicable to source sync block, for now (will be refactored further)
       this.sourceSyncBlockStoreManager.rebaseTransaction(incomingTr, state);
     }
+  }, {
+    key: "getReferenceSyncBlockProviderFactory",
+    value: function getReferenceSyncBlockProviderFactory(resourceId) {
+      return this.referenceSyncBlockStoreManager.getProviderFactory(resourceId);
+    }
   }, {
     key: "destroy",
     value: function destroy() {

package/dist/es2019/hooks/useFetchSyncBlockData.js

@@ -36,8 +36,9 @@ export const useFetchSyncBlockData = (manager, resourceId, localId) => {
     };
   }, [localId, referenceSyncBlockStoreManager, resourceId]);
   return {
-    syncBlockInstance,
     isLoading,
-    reloadData
+    providerFactory: referenceSyncBlockStoreManager.getProviderFactory(resourceId || ''),
+    reloadData,
+    syncBlockInstance
   };
 };

package/dist/es2019/providers/syncBlockProvider.js

@@ -5,19 +5,52 @@ import { SyncBlockDataProvider } from '../providers/types';
 import { getLocalIdFromAri, getPageARIFromResourceId } from '../utils/ari';
 import { fetchSourceInfo } from '../utils/sourceInfo';
 export class SyncBlockProvider extends SyncBlockDataProvider {
-  constructor(fetchProvider, writeProvider, sourceId) {
+  /**
+   * Constructor for the SyncBlockProvider
+   *
+   * @param fetchProvider
+   * @param writeProvider
+   * @param sourceId
+   * @param nestedRendererDataProviders
+   */
+  constructor(fetchProvider, writeProvider, sourceId, providerOptions) {
     super();
     _defineProperty(this, "name", 'syncBlockProvider');
     this.fetchProvider = fetchProvider;
     this.writeProvider = writeProvider;
     this.sourceId = sourceId;
+    this.providerOptions = providerOptions;
   }
+
+  /**
+   * Check if the node is supported by the provider
+   *
+   * @param node
+   *
+   * @returns True if the node is supported, false otherwise
+   */
   isNodeSupported(node) {
-    return node.type === 'syncBlock';
+    return node.type === 'syncBlock' || node.type === 'bodiedSyncBlock';
   }
+
+  /**
+   * Get the data key for the node
+   *
+   * @param node
+   *
+   * @returns The data key
+   */
   nodeDataKey(node) {
     return node.attrs.localId;
   }
+
+  /**
+   * Fetch the data from the fetch provider
+   *
+   * @param nodes
+   *
+   * @returns Array of {resourceId?: string, error?: string}.
+   */
   fetchNodesData(nodes) {
     const resourceIdSet = new Set(nodes.map(node => node.attrs.resourceId));
     const resourceIds = [...resourceIdSet];
@@ -38,6 +71,7 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
   }
 
   /**
+   * Write the data to the write provider
    *
    * @param nodes
    * @param data
@@ -62,6 +96,14 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
       }
     });
   }
+
+  /**
+   * Delete the data from the write provider
+   *
+   * @param resourceIds
+   *
+   * @returns Array of {resourceId?: string, error?: string}.
+   */
   async deleteNodesData(resourceIds) {
     const results = await Promise.allSettled(resourceIds.map(resourceId => this.writeProvider.deleteData(resourceId)));
     return results.map((result, index) => {
@@ -76,9 +118,23 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
       }
     });
   }
+
+  /**
+   * Get the source id
+   *
+   * @returns The source id
+   */
   getSourceId() {
     return this.sourceId;
   }
+
+  /**
+   * Retrieve the source info from the source id
+   *
+   * @param node
+   *
+   * @returns The source info
+   */
   retrieveSyncBlockSourceInfo(node) {
     const {
       resourceId
@@ -102,9 +158,18 @@ export class SyncBlockProvider extends SyncBlockDataProvider {
   generateResourceId(sourceId, localId) {
     return this.writeProvider.generateResourceId(sourceId, localId);
   }
+
+  /**
+   * Get the synced block renderer provider options
+   *
+   * @returns The synced block renderer provider options
+   */
+  getSyncedBlockRendererProviderOptions() {
+    return this.providerOptions;
+  }
 }
-export const useMemoizedSyncedBlockProvider = (fetchProvider, writeProvider, sourceId) => {
+export const useMemoizedSyncedBlockProvider = (fetchProvider, writeProvider, sourceId, providerOptions) => {
   return useMemo(() => {
-    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId);
-  }, [fetchProvider, writeProvider, sourceId]);
+    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
+  }, [fetchProvider, writeProvider, sourceId, providerOptions]);
 };

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

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { SyncBlockError } from '../common/types';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { createSyncBlockNode } from '../utils/utils';
@@ -10,6 +11,7 @@ export class ReferenceSyncBlockStoreManager {
     this.titleSubscriptions = new Map();
     this.dataProvider = dataProvider;
     this.syncBlockURLRequests = new Map();
+    this.providerFactories = new Map();
   }
 
   /**
@@ -134,6 +136,7 @@ export class ReferenceSyncBlockStoreManager {
   }
   deleteFromCache(resourceId) {
     this.syncBlockCache.delete(resourceId);
+    this.providerFactories.delete(resourceId);
   }
   subscribeToSyncBlock(resourceId, localId, callback) {
     // add to subscriptions map
@@ -227,9 +230,31 @@ export class ReferenceSyncBlockStoreManager {
     }
     return (_syncBlock$data = syncBlock.data) === null || _syncBlock$data === void 0 ? void 0 : _syncBlock$data.sourceURL;
   }
+  getProviderFactory(resourceId) {
+    if (!this.dataProvider) {
+      return undefined;
+    }
+    const {
+      parentDataProviders
+    } = this.dataProvider.getSyncedBlockRendererProviderOptions();
+    if (!this.providerFactories.has(resourceId)) {
+      // TODO: EDITOR-2771 - In follow up PR, create media & emoji providers per ref sync block
+      // The media & emoji providers will be set later, once we get ref sync block data with page ID
+      // So we need to keep the reference to the Provider Factory so we can then set media & emoji providers later
+      this.providerFactories.set(resourceId, ProviderFactory.create({
+        emojiProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.emojiProvider,
+        mediaProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mediaProvider,
+        mentionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mentionProvider,
+        profilecardProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.profilecardProvider,
+        taskDecisionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.taskDecisionProvider
+      }));
+    }
+    return this.providerFactories.get(resourceId);
+  }
   destroy() {
     this.syncBlockCache.clear();
     this.subscriptions.clear();
     this.syncBlockURLRequests.clear();
+    this.providerFactories.clear();
   }
 }

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

@@ -122,6 +122,9 @@ export class SyncBlockStoreManager {
     // only applicable to source sync block, for now (will be refactored further)
     this.sourceSyncBlockStoreManager.rebaseTransaction(incomingTr, state);
   }
+  getReferenceSyncBlockProviderFactory(resourceId) {
+    return this.referenceSyncBlockStoreManager.getProviderFactory(resourceId);
+  }
   destroy() {
     this.referenceSyncBlockStoreManager.destroy();
   }

package/dist/esm/hooks/useFetchSyncBlockData.js

@@ -65,8 +65,9 @@ export var useFetchSyncBlockData = function useFetchSyncBlockData(manager, resou
     };
   }, [localId, referenceSyncBlockStoreManager, resourceId]);
   return {
-    syncBlockInstance: syncBlockInstance,
     isLoading: isLoading,
-    reloadData: reloadData
+    providerFactory: referenceSyncBlockStoreManager.getProviderFactory(resourceId || ''),
+    reloadData: reloadData,
+    syncBlockInstance: syncBlockInstance
   };
 };

package/dist/esm/providers/syncBlockProvider.js

@@ -15,7 +15,15 @@ import { SyncBlockDataProvider } from '../providers/types';
 import { getLocalIdFromAri, getPageARIFromResourceId } from '../utils/ari';
 import { fetchSourceInfo } from '../utils/sourceInfo';
 export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
-  function SyncBlockProvider(fetchProvider, writeProvider, sourceId) {
+  /**
+   * Constructor for the SyncBlockProvider
+   *
+   * @param fetchProvider
+   * @param writeProvider
+   * @param sourceId
+   * @param nestedRendererDataProviders
+   */
+  function SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions) {
     var _this;
     _classCallCheck(this, SyncBlockProvider);
     _this = _callSuper(this, SyncBlockProvider);
@@ -23,19 +31,44 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     _this.fetchProvider = fetchProvider;
     _this.writeProvider = writeProvider;
     _this.sourceId = sourceId;
+    _this.providerOptions = providerOptions;
     return _this;
   }
+
+  /**
+   * Check if the node is supported by the provider
+   *
+   * @param node
+   *
+   * @returns True if the node is supported, false otherwise
+   */
   _inherits(SyncBlockProvider, _SyncBlockDataProvide);
   return _createClass(SyncBlockProvider, [{
     key: "isNodeSupported",
     value: function isNodeSupported(node) {
-      return node.type === 'syncBlock';
+      return node.type === 'syncBlock' || node.type === 'bodiedSyncBlock';
     }
+
+    /**
+     * Get the data key for the node
+     *
+     * @param node
+     *
+     * @returns The data key
+     */
   }, {
     key: "nodeDataKey",
     value: function nodeDataKey(node) {
       return node.attrs.localId;
     }
+
+    /**
+     * Fetch the data from the fetch provider
+     *
+     * @param nodes
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
   }, {
     key: "fetchNodesData",
     value: function fetchNodesData(nodes) {
@@ -63,6 +96,7 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     }
 
     /**
+     * Write the data to the write provider
      *
      * @param nodes
      * @param data
@@ -107,10 +141,18 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
         return _writeNodesData.apply(this, arguments);
       }
       return writeNodesData;
-    }())
+    }()
+    /**
+     * Delete the data from the write provider
+     *
+     * @param resourceIds
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
+    )
   }, {
     key: "deleteNodesData",
-    value: function () {
+    value: (function () {
       var _deleteNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(resourceIds) {
         var _this4 = this;
         var results;
@@ -145,11 +187,25 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
       }
       return deleteNodesData;
     }()
+    /**
+     * Get the source id
+     *
+     * @returns The source id
+     */
+    )
   }, {
     key: "getSourceId",
     value: function getSourceId() {
       return this.sourceId;
     }
+
+    /**
+     * Retrieve the source info from the source id
+     *
+     * @param node
+     *
+     * @returns The source info
+     */
   }, {
     key: "retrieveSyncBlockSourceInfo",
     value: function retrieveSyncBlockSourceInfo(node) {
@@ -175,10 +231,21 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     value: function generateResourceId(sourceId, localId) {
       return this.writeProvider.generateResourceId(sourceId, localId);
     }
+
+    /**
+     * Get the synced block renderer provider options
+     *
+     * @returns The synced block renderer provider options
+     */
+  }, {
+    key: "getSyncedBlockRendererProviderOptions",
+    value: function getSyncedBlockRendererProviderOptions() {
+      return this.providerOptions;
+    }
   }]);
 }(SyncBlockDataProvider);
-export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId) {
+export var useMemoizedSyncedBlockProvider = function useMemoizedSyncedBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions) {
   return useMemo(function () {
-    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId);
-  }, [fetchProvider, writeProvider, sourceId]);
+    return new SyncBlockProvider(fetchProvider, writeProvider, sourceId, providerOptions);
+  }, [fetchProvider, writeProvider, sourceId, providerOptions]);
 };

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

@@ -9,6 +9,7 @@ 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 { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { SyncBlockError } from '../common/types';
 import { resolveSyncBlockInstance } from '../utils/resolveSyncBlockInstance';
 import { createSyncBlockNode } from '../utils/utils';
@@ -21,6 +22,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     this.titleSubscriptions = new Map();
     this.dataProvider = dataProvider;
     this.syncBlockURLRequests = new Map();
+    this.providerFactories = new Map();
   }
 
   /**
@@ -236,6 +238,7 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
     key: "deleteFromCache",
     value: function deleteFromCache(resourceId) {
       this.syncBlockCache.delete(resourceId);
+      this.providerFactories.delete(resourceId);
     }
   }, {
     key: "subscribeToSyncBlock",
@@ -331,12 +334,35 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       }
       return (_syncBlock$data = syncBlock.data) === null || _syncBlock$data === void 0 ? void 0 : _syncBlock$data.sourceURL;
     }
+  }, {
+    key: "getProviderFactory",
+    value: function getProviderFactory(resourceId) {
+      if (!this.dataProvider) {
+        return undefined;
+      }
+      var _this$dataProvider$ge = this.dataProvider.getSyncedBlockRendererProviderOptions(),
+        parentDataProviders = _this$dataProvider$ge.parentDataProviders;
+      if (!this.providerFactories.has(resourceId)) {
+        // TODO: EDITOR-2771 - In follow up PR, create media & emoji providers per ref sync block
+        // The media & emoji providers will be set later, once we get ref sync block data with page ID
+        // So we need to keep the reference to the Provider Factory so we can then set media & emoji providers later
+        this.providerFactories.set(resourceId, ProviderFactory.create({
+          emojiProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.emojiProvider,
+          mediaProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mediaProvider,
+          mentionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.mentionProvider,
+          profilecardProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.profilecardProvider,
+          taskDecisionProvider: parentDataProviders === null || parentDataProviders === void 0 ? void 0 : parentDataProviders.taskDecisionProvider
+        }));
+      }
+      return this.providerFactories.get(resourceId);
+    }
   }, {
     key: "destroy",
     value: function destroy() {
       this.syncBlockCache.clear();
       this.subscriptions.clear();
       this.syncBlockURLRequests.clear();
+      this.providerFactories.clear();
     }
   }]);
 }();

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

@@ -165,6 +165,11 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
       // only applicable to source sync block, for now (will be refactored further)
       this.sourceSyncBlockStoreManager.rebaseTransaction(incomingTr, state);
     }
+  }, {
+    key: "getReferenceSyncBlockProviderFactory",
+    value: function getReferenceSyncBlockProviderFactory(resourceId) {
+      return this.referenceSyncBlockStoreManager.getProviderFactory(resourceId);
+    }
   }, {
     key: "destroy",
     value: function destroy() {

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

@@ -1,7 +1,9 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { SyncBlockInstance } from '../providers/types';
 import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
 export interface UseFetchSyncBlockDataResult {
     isLoading: boolean;
+    providerFactory: ProviderFactory | undefined;
     reloadData: () => Promise<void>;
     syncBlockInstance: SyncBlockInstance | null;
 }

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

@@ -1,16 +1,47 @@
 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, type WriteSyncBlockResult } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
     private writeProvider;
     private sourceId;
-    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string);
+    private providerOptions;
+    /**
+     * Constructor for the SyncBlockProvider
+     *
+     * @param fetchProvider
+     * @param writeProvider
+     * @param sourceId
+     * @param nestedRendererDataProviders
+     */
+    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions);
+    /**
+     * Check if the node is supported by the provider
+     *
+     * @param node
+     *
+     * @returns True if the node is supported, false otherwise
+     */
     isNodeSupported(node: JSONNode): node is SyncBlockNode;
+    /**
+     * Get the data key for the node
+     *
+     * @param node
+     *
+     * @returns The data key
+     */
     nodeDataKey(node: SyncBlockNode): string;
+    /**
+     * Fetch the data from the fetch provider
+     *
+     * @param nodes
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     fetchNodesData(nodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     /**
+     * Write the data to the write provider
      *
      * @param nodes
      * @param data
@@ -19,9 +50,34 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
+    /**
+     * Delete the data from the write provider
+     *
+     * @param resourceIds
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
+    /**
+     * Get the source id
+     *
+     * @returns The source id
+     */
     getSourceId(): string;
+    /**
+     * Retrieve the source info from the source id
+     *
+     * @param node
+     *
+     * @returns The source info
+     */
     retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
     generateResourceId(sourceId: string, localId: string): string;
+    /**
+     * Get the synced block renderer provider options
+     *
+     * @returns The synced block renderer provider options
+     */
+    getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
 }
-export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;
+export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions) => SyncBlockProvider;

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

@@ -1,3 +1,5 @@
+import type { SyncedBlockRendererDataProviders, MediaProvider } from '@atlaskit/editor-common/provider-factory';
+import type { EmojiProvider } from '@atlaskit/emoji';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode } from '../common/types';
 /**
@@ -31,11 +33,24 @@ export interface ADFWriteProvider {
     generateResourceId: (sourceId: string, localId: string) => ResourceId;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
+export type MediaEmojiProviderOptions = {
+    contentId: string;
+    contentType: string;
+    spaceKey?: string | null;
+};
+export type SyncedBlockRendererProviderOptions = {
+    parentDataProviders?: SyncedBlockRendererDataProviders;
+    providerCreator?: {
+        createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider>) | undefined;
+        createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider>) | undefined;
+    };
+};
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
     /**
      * Generates a resource ID from a source ID and local ID.
      * @param sourceId - The source document ID (e.g., page ARI)

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

@@ -1,3 +1,4 @@
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockNode } from '../common/types';
 import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
@@ -6,6 +7,7 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockCache;
     private subscriptions;
     private titleSubscriptions;
+    private providerFactories;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -29,5 +31,6 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns
      */
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
+    getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

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

@@ -1,3 +1,4 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 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';
@@ -60,5 +61,6 @@ export declare class SyncBlockStoreManager {
     refreshSubscriptions(): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    getReferenceSyncBlockProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

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

@@ -1,7 +1,9 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { SyncBlockInstance } from '../providers/types';
 import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
 export interface UseFetchSyncBlockDataResult {
     isLoading: boolean;
+    providerFactory: ProviderFactory | undefined;
     reloadData: () => Promise<void>;
     syncBlockInstance: SyncBlockInstance | null;
 }

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

@@ -1,16 +1,47 @@
 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, type WriteSyncBlockResult } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
     private writeProvider;
     private sourceId;
-    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string);
+    private providerOptions;
+    /**
+     * Constructor for the SyncBlockProvider
+     *
+     * @param fetchProvider
+     * @param writeProvider
+     * @param sourceId
+     * @param nestedRendererDataProviders
+     */
+    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions);
+    /**
+     * Check if the node is supported by the provider
+     *
+     * @param node
+     *
+     * @returns True if the node is supported, false otherwise
+     */
     isNodeSupported(node: JSONNode): node is SyncBlockNode;
+    /**
+     * Get the data key for the node
+     *
+     * @param node
+     *
+     * @returns The data key
+     */
     nodeDataKey(node: SyncBlockNode): string;
+    /**
+     * Fetch the data from the fetch provider
+     *
+     * @param nodes
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     fetchNodesData(nodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     /**
+     * Write the data to the write provider
      *
      * @param nodes
      * @param data
@@ -19,9 +50,34 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
+    /**
+     * Delete the data from the write provider
+     *
+     * @param resourceIds
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
+    /**
+     * Get the source id
+     *
+     * @returns The source id
+     */
     getSourceId(): string;
+    /**
+     * Retrieve the source info from the source id
+     *
+     * @param node
+     *
+     * @returns The source info
+     */
     retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
     generateResourceId(sourceId: string, localId: string): string;
+    /**
+     * Get the synced block renderer provider options
+     *
+     * @returns The synced block renderer provider options
+     */
+    getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
 }
-export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;
+export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions) => SyncBlockProvider;

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

@@ -1,3 +1,5 @@
+import type { SyncedBlockRendererDataProviders, MediaProvider } from '@atlaskit/editor-common/provider-factory';
+import type { EmojiProvider } from '@atlaskit/emoji';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode } from '../common/types';
 /**
@@ -31,11 +33,24 @@ export interface ADFWriteProvider {
     generateResourceId: (sourceId: string, localId: string) => ResourceId;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
+export type MediaEmojiProviderOptions = {
+    contentId: string;
+    contentType: string;
+    spaceKey?: string | null;
+};
+export type SyncedBlockRendererProviderOptions = {
+    parentDataProviders?: SyncedBlockRendererDataProviders;
+    providerCreator?: {
+        createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider>) | undefined;
+        createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider>) | undefined;
+    };
+};
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
     /**
      * Generates a resource ID from a source ID and local ID.
      * @param sourceId - The source document ID (e.g., page ARI)

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

@@ -1,3 +1,4 @@
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockNode } from '../common/types';
 import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
@@ -6,6 +7,7 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockCache;
     private subscriptions;
     private titleSubscriptions;
+    private providerFactories;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -29,5 +31,6 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns
      */
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
+    getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

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

@@ -1,3 +1,4 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 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';
@@ -60,5 +61,6 @@ export declare class SyncBlockStoreManager {
     refreshSubscriptions(): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    getReferenceSyncBlockProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

package/package.json

@@ -38,6 +38,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
+		"@atlaskit/editor-common": "^110.30.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -83,7 +84,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.9.0",
+	"version": "2.9.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",