@atlaskit/node-data-provider 7.2.2 → 7.4.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @atlaskit/node-data-provider
 
+## 7.4.0
+
+### Minor Changes
+
+- [`fdba2e94783b7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/fdba2e94783b7) -
+  [https://product-fabric.atlassian.net/browse/ED-29638](ED-29638) - fix editor NodeDataProvider
+  network requests deduplication
+
+### Patch Changes
+
+- Updated dependencies
+
+## 7.3.0
+
+### Minor Changes
+
+- [`5319dac3f8740`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5319dac3f8740) -
+  Do not re-fetch emoji on a client after successful ssr
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 7.2.2
 
 ### Patch Changes

package/dist/cjs/node-data-provider.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.NodeDataProvider = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
-var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -31,7 +30,7 @@ var _coreUtils = require("@atlaskit/editor-common/core-utils");
  * @example
  * {
  *   'node-id-1': { source: 'ssr', data: { value: 'some data' } },
- *   'node-id-2': { source: 'network', data: Promise.resolve({ value: 'other data' }) }
+ *   'node-id-2': { source: 'network', data: { value: 'other data' } }
  * }
  */
 /**
@@ -50,6 +49,7 @@ var NodeDataProvider = exports.NodeDataProvider = /*#__PURE__*/function () {
     (0, _classCallCheck2.default)(this, NodeDataProvider);
     this.cacheVersion = 0;
     this.cache = {};
+    this.networkRequestsInFlight = {};
   }
 
   /**
@@ -136,102 +136,114 @@ var NodeDataProvider = exports.NodeDataProvider = /*#__PURE__*/function () {
     key: "getDataAsync",
     value: function () {
       var _getDataAsync = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(node, callback) {
-        var jsonNode, _dataKey, dataFromCache, cacheVersionBeforeRequest, dataPromise, data;
+        var jsonNode, dataKey, dataFromCache, cacheVersionBeforeRequest, networkRequestInFlightKey, networkRequestInFlight, data, dataPromise, _data;
         return _regenerator.default.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              _context.prev = 0;
               jsonNode = 'toJSON' in node ? node.toJSON() : node;
               if (this.isNodeSupported(jsonNode)) {
-                _context.next = 5;
+                _context.next = 4;
                 break;
               }
               // eslint-disable-next-line no-console
               console.error("The ".concat(this.constructor.name, " doesn't support Node ").concat(jsonNode.type, "."));
               return _context.abrupt("return");
-            case 5:
-              _dataKey = this.nodeDataKey(jsonNode);
-              dataFromCache = this.cache[_dataKey];
+            case 4:
+              dataKey = this.nodeDataKey(jsonNode);
+              dataFromCache = this.cache[dataKey];
               if (!(dataFromCache !== undefined)) {
-                _context.next = 20;
+                _context.next = 10;
                 break;
               }
-              if (!isPromise(dataFromCache.data)) {
-                _context.next = 17;
-                break;
-              }
-              _context.t0 = callback;
-              _context.next = 12;
-              return dataFromCache.data;
-            case 12:
-              _context.t1 = _context.sent;
-              _context.t2 = {
-                data: _context.t1
-              };
-              (0, _context.t0)(_context.t2);
-              _context.next = 18;
-              break;
-            case 17:
+              // If we have the data in the SSR data, we can use it directly
               callback({
                 data: dataFromCache.data
               });
-            case 18:
               if (!(0, _coreUtils.isSSR)()) {
-                _context.next = 20;
+                _context.next = 10;
                 break;
               }
               return _context.abrupt("return");
-            case 20:
+            case 10:
               if (!((dataFromCache === null || dataFromCache === void 0 ? void 0 : dataFromCache.source) !== 'network')) {
-                _context.next = 29;
+                _context.next = 42;
                 break;
               }
               // Store the current cache version before making the request,
               // so we can check if the cache has changed while we are waiting for the network response.
-              cacheVersionBeforeRequest = this.cacheVersion;
+              cacheVersionBeforeRequest = this.cacheVersion; // Create a unique key for the in-flight network request
+              // based on the cache version and the data key.
+              networkRequestInFlightKey = "".concat(cacheVersionBeforeRequest, "-").concat(dataKey); // Check if there is already a network request in flight for this data
+              // to avoid duplicate requests.
+              networkRequestInFlight = this.networkRequestsInFlight[networkRequestInFlightKey];
+              if (!networkRequestInFlight) {
+                _context.next = 26;
+                break;
+              }
+              _context.prev = 15;
+              _context.next = 18;
+              return networkRequestInFlight;
+            case 18:
+              data = _context.sent;
+              callback({
+                data: data
+              });
+              _context.next = 25;
+              break;
+            case 22:
+              _context.prev = 22;
+              _context.t0 = _context["catch"](15);
+              callback({
+                error: _context.t0 instanceof Error ? _context.t0 : new Error(String(_context.t0))
+              });
+            case 25:
+              return _context.abrupt("return");
+            case 26:
+              _context.prev = 26;
               dataPromise = this.fetchNodesData([jsonNode]).then(function (_ref3) {
                 var _ref4 = (0, _slicedToArray2.default)(_ref3, 1),
                   value = _ref4[0];
                 return value;
-              }); // Store the promise in the cache to avoid multiple requests for the same data
-              this.cache[_dataKey] = {
-                source: 'network',
-                data: dataPromise
-              };
-              _context.next = 26;
+              }); // Store the promise in the in-flight requests map
+              this.networkRequestsInFlight[networkRequestInFlightKey] = dataPromise;
+              _context.next = 31;
               return dataPromise;
-            case 26:
-              data = _context.sent;
+            case 31:
+              _data = _context.sent;
               // We need to call the callback with the data with result even if the cache version has changed,
               // so all promises that are waiting for the data can resolve.
               callback({
-                data: data
+                data: _data
               });
 
               // If the cache version has changed, we don't want to use the data from the network
               // because it could be stale data.
               if (cacheVersionBeforeRequest === this.cacheVersion) {
                 // Replace promise with the resolved data in the cache
-                this.cache[_dataKey] = {
+                this.cache[dataKey] = {
                   source: 'network',
-                  data: data
+                  data: _data
                 };
               }
-            case 29:
-              _context.next = 34;
+              _context.next = 39;
               break;
-            case 31:
-              _context.prev = 31;
-              _context.t3 = _context["catch"](0);
+            case 36:
+              _context.prev = 36;
+              _context.t1 = _context["catch"](26);
               // If an error occurs, we call the callback with the error
               callback({
-                error: _context.t3 instanceof Error ? _context.t3 : new Error(String(_context.t3))
+                error: _context.t1 instanceof Error ? _context.t1 : new Error(String(_context.t1))
               });
-            case 34:
+            case 39:
+              _context.prev = 39;
+              // Ensure we clean up the in-flight request entry
+              delete this.networkRequestsInFlight[networkRequestInFlightKey];
+              return _context.finish(39);
+            case 42:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 31]]);
+        }, _callee, this, [[15, 22], [26, 36, 39, 42]]);
       }));
       function getDataAsync(_x, _x2) {
         return _getDataAsync.apply(this, arguments);
@@ -287,18 +299,27 @@ var NodeDataProvider = exports.NodeDataProvider = /*#__PURE__*/function () {
   }, {
     key: "getCacheStatusForNode",
     value: function getCacheStatusForNode(node) {
+      var dataFromCache = this.getNodeDataFromCache(node);
+      return dataFromCache ? dataFromCache.source : false;
+    }
+
+    /**
+     * Retrieves the cached data for a given node, if available.
+     *
+     * @param node The node (or its ProseMirror representation) for which to retrieve cached data.
+     * @returns The cached data object containing `data` and `source`, or `undefined` if no cache entry exists.
+     */
+  }, {
+    key: "getNodeDataFromCache",
+    value: function getNodeDataFromCache(node) {
       var jsonNode = 'toJSON' in node ? node.toJSON() : node;
       if (!this.isNodeSupported(jsonNode)) {
         // eslint-disable-next-line no-console
         console.error("The ".concat(this.constructor.name, " doesn't support Node ").concat(jsonNode.type, "."));
-        return false;
+        return undefined;
       }
       var dataKey = this.nodeDataKey(jsonNode);
-      var dataFromCache = this.cache[dataKey];
-      return dataFromCache ? dataFromCache.source : false;
+      return this.cache[dataKey];
     }
   }]);
-}();
-function isPromise(value) {
-  return (0, _typeof2.default)(value) === 'object' && value !== null && 'then' in value && typeof value.then === 'function';
-}
+}();

package/dist/es2019/node-data-provider.js

@@ -20,7 +20,7 @@ import { isSSR } from '@atlaskit/editor-common/core-utils';
  * @example
  * {
  *   'node-id-1': { source: 'ssr', data: { value: 'some data' } },
- *   'node-id-2': { source: 'network', data: Promise.resolve({ value: 'other data' }) }
+ *   'node-id-2': { source: 'network', data: { value: 'other data' } }
  * }
  */
 
@@ -66,6 +66,7 @@ export class NodeDataProvider {
   constructor() {
     this.cacheVersion = 0;
     this.cache = {};
+    this.networkRequestsInFlight = {};
   }
 
   /**
@@ -137,45 +138,59 @@ export class NodeDataProvider {
     void this.getDataAsync(node, callback);
   }
   async getDataAsync(node, callback) {
-    try {
-      const jsonNode = 'toJSON' in node ? node.toJSON() : node;
-      if (!this.isNodeSupported(jsonNode)) {
-        // eslint-disable-next-line no-console
-        console.error(`The ${this.constructor.name} doesn't support Node ${jsonNode.type}.`);
+    const jsonNode = 'toJSON' in node ? node.toJSON() : node;
+    if (!this.isNodeSupported(jsonNode)) {
+      // eslint-disable-next-line no-console
+      console.error(`The ${this.constructor.name} doesn't support Node ${jsonNode.type}.`);
+      return;
+    }
+    const dataKey = this.nodeDataKey(jsonNode);
+    const dataFromCache = this.cache[dataKey];
+    if (dataFromCache !== undefined) {
+      // If we have the data in the SSR data, we can use it directly
+      callback({
+        data: dataFromCache.data
+      });
+      if (isSSR()) {
+        // If we are in SSR, we don't want to fetch the data again, as it is already available in the SSR data
         return;
       }
-      const dataKey = this.nodeDataKey(jsonNode);
-      const dataFromCache = this.cache[dataKey];
-      if (dataFromCache !== undefined) {
-        // If we have the data in the SSR data, we can use it directly
-        if (isPromise(dataFromCache.data)) {
+    }
+
+    // If no data is available in the cache, or the data is from the network,
+    // we need to fetch it from the network.
+    if ((dataFromCache === null || dataFromCache === void 0 ? void 0 : dataFromCache.source) !== 'network') {
+      // Store the current cache version before making the request,
+      // so we can check if the cache has changed while we are waiting for the network response.
+      const cacheVersionBeforeRequest = this.cacheVersion;
+
+      // Create a unique key for the in-flight network request
+      // based on the cache version and the data key.
+      const networkRequestInFlightKey = `${cacheVersionBeforeRequest}-${dataKey}`;
+
+      // Check if there is already a network request in flight for this data
+      // to avoid duplicate requests.
+      const networkRequestInFlight = this.networkRequestsInFlight[networkRequestInFlightKey];
+      if (networkRequestInFlight) {
+        try {
+          const data = await networkRequestInFlight;
           callback({
-            data: await dataFromCache.data
+            data
           });
-        } else {
+        } catch (error) {
           callback({
-            data: dataFromCache.data
+            error: error instanceof Error ? error : new Error(String(error))
           });
         }
-        if (isSSR()) {
-          // If we are in SSR, we don't want to fetch the data again, as it is already available in the SSR data
-          return;
-        }
+        return;
       }
-
-      // If no data is available in the cache or the data is from the network,
-      // we need to fetch it from the network.
-      if ((dataFromCache === null || dataFromCache === void 0 ? void 0 : dataFromCache.source) !== 'network') {
-        // Store the current cache version before making the request,
-        // so we can check if the cache has changed while we are waiting for the network response.
-        const cacheVersionBeforeRequest = this.cacheVersion;
+      try {
         const dataPromise = this.fetchNodesData([jsonNode]).then(([value]) => value);
-        // Store the promise in the cache to avoid multiple requests for the same data
-        this.cache[dataKey] = {
-          source: 'network',
-          data: dataPromise
-        };
+
+        // Store the promise in the in-flight requests map
+        this.networkRequestsInFlight[networkRequestInFlightKey] = dataPromise;
         const data = await dataPromise;
+
         // We need to call the callback with the data with result even if the cache version has changed,
         // so all promises that are waiting for the data can resolve.
         callback({
@@ -191,12 +206,15 @@ export class NodeDataProvider {
             data
           };
         }
+      } catch (error) {
+        // If an error occurs, we call the callback with the error
+        callback({
+          error: error instanceof Error ? error : new Error(String(error))
+        });
+      } finally {
+        // Ensure we clean up the in-flight request entry
+        delete this.networkRequestsInFlight[networkRequestInFlightKey];
       }
-    } catch (error) {
-      // If an error occurs, we call the callback with the error
-      callback({
-        error: error instanceof Error ? error : new Error(String(error))
-      });
     }
   }
 
@@ -244,17 +262,24 @@ export class NodeDataProvider {
    * @returns The cache status: `false`, `'ssr'`, or `'network'`.
    */
   getCacheStatusForNode(node) {
+    const dataFromCache = this.getNodeDataFromCache(node);
+    return dataFromCache ? dataFromCache.source : false;
+  }
+
+  /**
+   * Retrieves the cached data for a given node, if available.
+   *
+   * @param node The node (or its ProseMirror representation) for which to retrieve cached data.
+   * @returns The cached data object containing `data` and `source`, or `undefined` if no cache entry exists.
+   */
+  getNodeDataFromCache(node) {
     const jsonNode = 'toJSON' in node ? node.toJSON() : node;
     if (!this.isNodeSupported(jsonNode)) {
       // eslint-disable-next-line no-console
       console.error(`The ${this.constructor.name} doesn't support Node ${jsonNode.type}.`);
-      return false;
+      return undefined;
     }
     const dataKey = this.nodeDataKey(jsonNode);
-    const dataFromCache = this.cache[dataKey];
-    return dataFromCache ? dataFromCache.source : false;
+    return this.cache[dataKey];
   }
-}
-function isPromise(value) {
-  return typeof value === 'object' && value !== null && 'then' in value && typeof value.then === 'function';
 }

package/dist/esm/node-data-provider.js

@@ -1,4 +1,3 @@
-import _typeof from "@babel/runtime/helpers/typeof";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
@@ -26,7 +25,7 @@ import { isSSR } from '@atlaskit/editor-common/core-utils';
  * @example
  * {
  *   'node-id-1': { source: 'ssr', data: { value: 'some data' } },
- *   'node-id-2': { source: 'network', data: Promise.resolve({ value: 'other data' }) }
+ *   'node-id-2': { source: 'network', data: { value: 'other data' } }
  * }
  */
 
@@ -47,6 +46,7 @@ export var NodeDataProvider = /*#__PURE__*/function () {
     _classCallCheck(this, NodeDataProvider);
     this.cacheVersion = 0;
     this.cache = {};
+    this.networkRequestsInFlight = {};
   }
 
   /**
@@ -133,102 +133,114 @@ export var NodeDataProvider = /*#__PURE__*/function () {
     key: "getDataAsync",
     value: function () {
       var _getDataAsync = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(node, callback) {
-        var jsonNode, _dataKey, dataFromCache, cacheVersionBeforeRequest, dataPromise, data;
+        var jsonNode, dataKey, dataFromCache, cacheVersionBeforeRequest, networkRequestInFlightKey, networkRequestInFlight, data, dataPromise, _data;
         return _regeneratorRuntime.wrap(function _callee$(_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
-              _context.prev = 0;
               jsonNode = 'toJSON' in node ? node.toJSON() : node;
               if (this.isNodeSupported(jsonNode)) {
-                _context.next = 5;
+                _context.next = 4;
                 break;
               }
               // eslint-disable-next-line no-console
               console.error("The ".concat(this.constructor.name, " doesn't support Node ").concat(jsonNode.type, "."));
               return _context.abrupt("return");
-            case 5:
-              _dataKey = this.nodeDataKey(jsonNode);
-              dataFromCache = this.cache[_dataKey];
+            case 4:
+              dataKey = this.nodeDataKey(jsonNode);
+              dataFromCache = this.cache[dataKey];
               if (!(dataFromCache !== undefined)) {
-                _context.next = 20;
+                _context.next = 10;
                 break;
               }
-              if (!isPromise(dataFromCache.data)) {
-                _context.next = 17;
-                break;
-              }
-              _context.t0 = callback;
-              _context.next = 12;
-              return dataFromCache.data;
-            case 12:
-              _context.t1 = _context.sent;
-              _context.t2 = {
-                data: _context.t1
-              };
-              (0, _context.t0)(_context.t2);
-              _context.next = 18;
-              break;
-            case 17:
+              // If we have the data in the SSR data, we can use it directly
               callback({
                 data: dataFromCache.data
               });
-            case 18:
               if (!isSSR()) {
-                _context.next = 20;
+                _context.next = 10;
                 break;
               }
               return _context.abrupt("return");
-            case 20:
+            case 10:
               if (!((dataFromCache === null || dataFromCache === void 0 ? void 0 : dataFromCache.source) !== 'network')) {
-                _context.next = 29;
+                _context.next = 42;
                 break;
               }
               // Store the current cache version before making the request,
               // so we can check if the cache has changed while we are waiting for the network response.
-              cacheVersionBeforeRequest = this.cacheVersion;
+              cacheVersionBeforeRequest = this.cacheVersion; // Create a unique key for the in-flight network request
+              // based on the cache version and the data key.
+              networkRequestInFlightKey = "".concat(cacheVersionBeforeRequest, "-").concat(dataKey); // Check if there is already a network request in flight for this data
+              // to avoid duplicate requests.
+              networkRequestInFlight = this.networkRequestsInFlight[networkRequestInFlightKey];
+              if (!networkRequestInFlight) {
+                _context.next = 26;
+                break;
+              }
+              _context.prev = 15;
+              _context.next = 18;
+              return networkRequestInFlight;
+            case 18:
+              data = _context.sent;
+              callback({
+                data: data
+              });
+              _context.next = 25;
+              break;
+            case 22:
+              _context.prev = 22;
+              _context.t0 = _context["catch"](15);
+              callback({
+                error: _context.t0 instanceof Error ? _context.t0 : new Error(String(_context.t0))
+              });
+            case 25:
+              return _context.abrupt("return");
+            case 26:
+              _context.prev = 26;
               dataPromise = this.fetchNodesData([jsonNode]).then(function (_ref3) {
                 var _ref4 = _slicedToArray(_ref3, 1),
                   value = _ref4[0];
                 return value;
-              }); // Store the promise in the cache to avoid multiple requests for the same data
-              this.cache[_dataKey] = {
-                source: 'network',
-                data: dataPromise
-              };
-              _context.next = 26;
+              }); // Store the promise in the in-flight requests map
+              this.networkRequestsInFlight[networkRequestInFlightKey] = dataPromise;
+              _context.next = 31;
               return dataPromise;
-            case 26:
-              data = _context.sent;
+            case 31:
+              _data = _context.sent;
               // We need to call the callback with the data with result even if the cache version has changed,
               // so all promises that are waiting for the data can resolve.
               callback({
-                data: data
+                data: _data
               });
 
               // If the cache version has changed, we don't want to use the data from the network
               // because it could be stale data.
               if (cacheVersionBeforeRequest === this.cacheVersion) {
                 // Replace promise with the resolved data in the cache
-                this.cache[_dataKey] = {
+                this.cache[dataKey] = {
                   source: 'network',
-                  data: data
+                  data: _data
                 };
               }
-            case 29:
-              _context.next = 34;
+              _context.next = 39;
               break;
-            case 31:
-              _context.prev = 31;
-              _context.t3 = _context["catch"](0);
+            case 36:
+              _context.prev = 36;
+              _context.t1 = _context["catch"](26);
               // If an error occurs, we call the callback with the error
               callback({
-                error: _context.t3 instanceof Error ? _context.t3 : new Error(String(_context.t3))
+                error: _context.t1 instanceof Error ? _context.t1 : new Error(String(_context.t1))
               });
-            case 34:
+            case 39:
+              _context.prev = 39;
+              // Ensure we clean up the in-flight request entry
+              delete this.networkRequestsInFlight[networkRequestInFlightKey];
+              return _context.finish(39);
+            case 42:
             case "end":
               return _context.stop();
           }
-        }, _callee, this, [[0, 31]]);
+        }, _callee, this, [[15, 22], [26, 36, 39, 42]]);
       }));
       function getDataAsync(_x, _x2) {
         return _getDataAsync.apply(this, arguments);
@@ -284,18 +296,27 @@ export var NodeDataProvider = /*#__PURE__*/function () {
   }, {
     key: "getCacheStatusForNode",
     value: function getCacheStatusForNode(node) {
+      var dataFromCache = this.getNodeDataFromCache(node);
+      return dataFromCache ? dataFromCache.source : false;
+    }
+
+    /**
+     * Retrieves the cached data for a given node, if available.
+     *
+     * @param node The node (or its ProseMirror representation) for which to retrieve cached data.
+     * @returns The cached data object containing `data` and `source`, or `undefined` if no cache entry exists.
+     */
+  }, {
+    key: "getNodeDataFromCache",
+    value: function getNodeDataFromCache(node) {
       var jsonNode = 'toJSON' in node ? node.toJSON() : node;
       if (!this.isNodeSupported(jsonNode)) {
         // eslint-disable-next-line no-console
         console.error("The ".concat(this.constructor.name, " doesn't support Node ").concat(jsonNode.type, "."));
-        return false;
+        return undefined;
       }
       var dataKey = this.nodeDataKey(jsonNode);
-      var dataFromCache = this.cache[dataKey];
-      return dataFromCache ? dataFromCache.source : false;
+      return this.cache[dataKey];
     }
   }]);
-}();
-function isPromise(value) {
-  return _typeof(value) === 'object' && value !== null && 'then' in value && typeof value.then === 'function';
-}
+}();

package/dist/types/node-data-provider.d.ts

@@ -13,6 +13,22 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 type SSRData<Data> = {
     [dataKey: string]: Data;
 };
+/**
+ * Represents the cached data for a Node Data Provider.
+ * Each key is a unique node data key, and the value is an object containing:
+ * - `source`: Indicates whether the data was fetched from SSR or the network.
+ * - `data`: The actual data, which can be either a resolved value or a Promise.
+ *
+ * @example
+ * {
+ *   'node-id-1': { source: 'ssr', data: { value: 'some data' } },
+ *   'node-id-2': { source: 'network', data: { value: 'other data' } }
+ * }
+ */
+type CacheData<Data> = Record<string, {
+    data: Data;
+    source: 'ssr' | 'network';
+}>;
 /**
  * Represents the payload passed to the callback function when data is fetched.
  * It can either contain an error or the fetched data.
@@ -36,6 +52,7 @@ type CallbackPayload<Data> = {
 export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
     private cacheVersion;
     private cache;
+    private readonly networkRequestsInFlight;
     /**
      * A unique name for the provider. Used for identification in SSR.
      */
@@ -116,7 +133,7 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
      * @param callback The callback function to call with the fetched data or an error.
      */
     getData(node: Node | PMNode, callback: (payload: CallbackPayload<Data>) => void): void;
-    private getDataAsync;
+    protected getDataAsync(node: Node | PMNode, callback: (payload: CallbackPayload<Data>) => void): Promise<void>;
     /**
      * Fetches data for a given node and returns it as a Promise.
      * This is a convenience wrapper around the `data` method for use with async/await.
@@ -146,5 +163,12 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
      * @returns The cache status: `false`, `'ssr'`, or `'network'`.
      */
     getCacheStatusForNode(node: Node | PMNode): false | 'ssr' | 'network';
+    /**
+     * Retrieves the cached data for a given node, if available.
+     *
+     * @param node The node (or its ProseMirror representation) for which to retrieve cached data.
+     * @returns The cached data object containing `data` and `source`, or `undefined` if no cache entry exists.
+     */
+    getNodeDataFromCache(node: JSONNode | PMNode): CacheData<Data>[string] | undefined;
 }
 export {};

package/dist/types-ts4.5/node-data-provider.d.ts

@@ -13,6 +13,22 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 type SSRData<Data> = {
     [dataKey: string]: Data;
 };
+/**
+ * Represents the cached data for a Node Data Provider.
+ * Each key is a unique node data key, and the value is an object containing:
+ * - `source`: Indicates whether the data was fetched from SSR or the network.
+ * - `data`: The actual data, which can be either a resolved value or a Promise.
+ *
+ * @example
+ * {
+ *   'node-id-1': { source: 'ssr', data: { value: 'some data' } },
+ *   'node-id-2': { source: 'network', data: { value: 'other data' } }
+ * }
+ */
+type CacheData<Data> = Record<string, {
+    data: Data;
+    source: 'ssr' | 'network';
+}>;
 /**
  * Represents the payload passed to the callback function when data is fetched.
  * It can either contain an error or the fetched data.
@@ -36,6 +52,7 @@ type CallbackPayload<Data> = {
 export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
     private cacheVersion;
     private cache;
+    private readonly networkRequestsInFlight;
     /**
      * A unique name for the provider. Used for identification in SSR.
      */
@@ -116,7 +133,7 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
      * @param callback The callback function to call with the fetched data or an error.
      */
     getData(node: Node | PMNode, callback: (payload: CallbackPayload<Data>) => void): void;
-    private getDataAsync;
+    protected getDataAsync(node: Node | PMNode, callback: (payload: CallbackPayload<Data>) => void): Promise<void>;
     /**
      * Fetches data for a given node and returns it as a Promise.
      * This is a convenience wrapper around the `data` method for use with async/await.
@@ -146,5 +163,12 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
      * @returns The cache status: `false`, `'ssr'`, or `'network'`.
      */
     getCacheStatusForNode(node: Node | PMNode): false | 'ssr' | 'network';
+    /**
+     * Retrieves the cached data for a given node, if available.
+     *
+     * @param node The node (or its ProseMirror representation) for which to retrieve cached data.
+     * @returns The cached data object containing `data` and `source`, or `undefined` if no cache entry exists.
+     */
+    getNodeDataFromCache(node: JSONNode | PMNode): CacheData<Data>[string] | undefined;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/node-data-provider",
-	"version": "7.2.2",
+	"version": "7.4.0",
 	"description": "Node data provider for @atlaskit/editor-core plugins and @atlaskit/renderer",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -26,7 +26,7 @@
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.18.0"
+		"@atlaskit/editor-common": "^110.21.0"
 	},
 	"techstack": {
 		"@atlassian/frontend": {