@atlaskit/node-data-provider 8.0.0 → 8.2.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/node-data-provider
 
+## 8.2.0
+
+### Minor Changes
+
+- [`c9e2a2b390abf`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/c9e2a2b390abf) -
+  Batch retrieve should batch retrieve block calls in renderer
+
+## 8.1.0
+
+### Minor Changes
+
+- [`cfea9d4edb5f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/cfea9d4edb5f0) -
+  EDITOR-2849 refactor to use unify cache
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.0.0
 
 ### Patch Changes

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

@@ -6,11 +6,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.NodeDataProvider = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _coreUtils = require("@atlaskit/editor-common/core-utils");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 /**
  * Represents the SSR data for a single provider.
  * It's a map where each key is a unique node data key and the value is the prefetched data for that node.
@@ -69,6 +71,13 @@ var NodeDataProvider = exports.NodeDataProvider = /*#__PURE__*/function () {
     key: "setSSRData",
     value: function setSSRData() {
       var ssrData = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_1')) {
+        this.updateCache(ssrData, {
+          strategy: 'replace',
+          source: 'ssr'
+        });
+        return;
+      }
       this.cacheVersion++;
       this.cache = Object.fromEntries(Object.entries(ssrData).map(function (_ref) {
         var _ref2 = (0, _slicedToArray2.default)(_ref, 2),
@@ -218,10 +227,17 @@ var NodeDataProvider = exports.NodeDataProvider = /*#__PURE__*/function () {
               // because it could be stale data.
               if (cacheVersionBeforeRequest === this.cacheVersion) {
                 // Replace promise with the resolved data in the cache
-                this.cache[dataKey] = {
-                  source: 'network',
-                  data: _data
-                };
+                if ((0, _platformFeatureFlags.fg)('platform_synced_block_patch_1')) {
+                  this.updateCache((0, _defineProperty2.default)({}, dataKey, _data), {
+                    strategy: 'merge',
+                    source: 'network'
+                  });
+                } else {
+                  this.cache[dataKey] = {
+                    data: _data,
+                    source: 'network'
+                  };
+                }
               }
               _context.next = 38;
               break;
@@ -319,5 +335,77 @@ var NodeDataProvider = exports.NodeDataProvider = /*#__PURE__*/function () {
       var dataKey = this.nodeDataKey(jsonNode);
       return this.cache[dataKey];
     }
+
+    /**
+     * Updates the cache with new records using merge or replace strategies.
+     * This method should be the only way to modify the cache directly.
+     * This allow subclasses to use it when needed. e.g. abstract fetchNodesData implementation.
+     *
+     * @example
+     * ```
+     * const newRecords = {
+     *   'node-id-1': { value: 'updated data' },
+     *   'node-id-3': { value: 'new data' }
+     * };
+     * nodeDataProvider.updateCache(newRecords, { strategy: 'merge', source: 'network' });
+     * ```
+     *
+     * Supports two strategies:
+     * - 'merge' (default): Merges new records into the existing cache.
+     * - 'replace': Replaces the entire cache with the new records, invalidating any in-flight requests.
+     *
+     * @param records A map of node data keys to their corresponding data.
+     * @param options Optional settings for the update operation.
+     * @param options.strategy The strategy to use for updating the cache ('merge' or 'replace'). Defaults to 'merge'.
+     * @param options.source The source of the data being added ('ssr' or 'network'). Defaults to 'network'.
+     */
+  }, {
+    key: "updateCache",
+    value: function updateCache() {
+      var _options$strategy, _options$source;
+      var records = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var options = arguments.length > 1 ? arguments[1] : undefined;
+      var strategy = (_options$strategy = options === null || options === void 0 ? void 0 : options.strategy) !== null && _options$strategy !== void 0 ? _options$strategy : 'merge';
+      var source = (_options$source = options === null || options === void 0 ? void 0 : options.source) !== null && _options$source !== void 0 ? _options$source : 'network';
+      if (strategy === 'merge') {
+        for (var _i = 0, _Object$entries = Object.entries(records); _i < _Object$entries.length; _i++) {
+          var _Object$entries$_i = (0, _slicedToArray2.default)(_Object$entries[_i], 2),
+            key = _Object$entries$_i[0],
+            data = _Object$entries$_i[1];
+          this.cache[key] = {
+            data: data,
+            source: source
+          };
+        }
+        return;
+      } else if (strategy === 'replace') {
+        // Replace the entire cache with the new records
+        // This will increase the cache version to invalidate any in-flight requests
+        this.resetCache();
+        this.cache = Object.fromEntries(Object.entries(records).map(function (_ref5) {
+          var _ref6 = (0, _slicedToArray2.default)(_ref5, 2),
+            key = _ref6[0],
+            data = _ref6[1];
+          return [key, {
+            data: data,
+            source: source
+          }];
+        }));
+      }
+    }
+
+    /**
+     * Removes one or more entries from the cache.
+     *
+     * @param keys A single data key or array of data keys to remove from the cache.
+     */
+  }, {
+    key: "removeFromCache",
+    value: function removeFromCache(keys) {
+      var _this2 = this;
+      keys.forEach(function (key) {
+        delete _this2.cache[key];
+      });
+    }
   }]);
 }();

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

@@ -1,4 +1,5 @@
 import { isSSR } from '@atlaskit/editor-common/core-utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 
 /**
  * Represents the SSR data for a single provider.
@@ -83,6 +84,13 @@ export class NodeDataProvider {
    * @param ssrData A map of node data keys to their corresponding data.
    */
   setSSRData(ssrData = {}) {
+    if (fg('platform_synced_block_patch_1')) {
+      this.updateCache(ssrData, {
+        strategy: 'replace',
+        source: 'ssr'
+      });
+      return;
+    }
     this.cacheVersion++;
     this.cache = Object.fromEntries(Object.entries(ssrData).map(([key, data]) => [key, {
       data,
@@ -202,10 +210,19 @@ export class NodeDataProvider {
         // because it could be stale data.
         if (cacheVersionBeforeRequest === this.cacheVersion) {
           // Replace promise with the resolved data in the cache
-          this.cache[dataKey] = {
-            source: 'network',
-            data
-          };
+          if (fg('platform_synced_block_patch_1')) {
+            this.updateCache({
+              [dataKey]: data
+            }, {
+              strategy: 'merge',
+              source: 'network'
+            });
+          } else {
+            this.cache[dataKey] = {
+              data,
+              source: 'network'
+            };
+          }
         }
       } catch (error) {
         // If an error occurs, we call the callback with the error
@@ -283,4 +300,61 @@ export class NodeDataProvider {
     const dataKey = this.nodeDataKey(jsonNode);
     return this.cache[dataKey];
   }
+
+  /**
+   * Updates the cache with new records using merge or replace strategies.
+   * This method should be the only way to modify the cache directly.
+   * This allow subclasses to use it when needed. e.g. abstract fetchNodesData implementation.
+   *
+   * @example
+   * ```
+   * const newRecords = {
+   *   'node-id-1': { value: 'updated data' },
+   *   'node-id-3': { value: 'new data' }
+   * };
+   * nodeDataProvider.updateCache(newRecords, { strategy: 'merge', source: 'network' });
+   * ```
+   *
+   * Supports two strategies:
+   * - 'merge' (default): Merges new records into the existing cache.
+   * - 'replace': Replaces the entire cache with the new records, invalidating any in-flight requests.
+   *
+   * @param records A map of node data keys to their corresponding data.
+   * @param options Optional settings for the update operation.
+   * @param options.strategy The strategy to use for updating the cache ('merge' or 'replace'). Defaults to 'merge'.
+   * @param options.source The source of the data being added ('ssr' or 'network'). Defaults to 'network'.
+   */
+  updateCache(records = {}, options) {
+    var _options$strategy, _options$source;
+    const strategy = (_options$strategy = options === null || options === void 0 ? void 0 : options.strategy) !== null && _options$strategy !== void 0 ? _options$strategy : 'merge';
+    const source = (_options$source = options === null || options === void 0 ? void 0 : options.source) !== null && _options$source !== void 0 ? _options$source : 'network';
+    if (strategy === 'merge') {
+      for (const [key, data] of Object.entries(records)) {
+        this.cache[key] = {
+          data,
+          source
+        };
+      }
+      return;
+    } else if (strategy === 'replace') {
+      // Replace the entire cache with the new records
+      // This will increase the cache version to invalidate any in-flight requests
+      this.resetCache();
+      this.cache = Object.fromEntries(Object.entries(records).map(([key, data]) => [key, {
+        data,
+        source
+      }]));
+    }
+  }
+
+  /**
+   * Removes one or more entries from the cache.
+   *
+   * @param keys A single data key or array of data keys to remove from the cache.
+   */
+  removeFromCache(keys) {
+    keys.forEach(key => {
+      delete this.cache[key];
+    });
+  }
 }

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

@@ -1,9 +1,11 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 import { isSSR } from '@atlaskit/editor-common/core-utils';
+import { fg } from '@atlaskit/platform-feature-flags';
 
 /**
  * Represents the SSR data for a single provider.
@@ -66,6 +68,13 @@ export var NodeDataProvider = /*#__PURE__*/function () {
     key: "setSSRData",
     value: function setSSRData() {
       var ssrData = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      if (fg('platform_synced_block_patch_1')) {
+        this.updateCache(ssrData, {
+          strategy: 'replace',
+          source: 'ssr'
+        });
+        return;
+      }
       this.cacheVersion++;
       this.cache = Object.fromEntries(Object.entries(ssrData).map(function (_ref) {
         var _ref2 = _slicedToArray(_ref, 2),
@@ -215,10 +224,17 @@ export var NodeDataProvider = /*#__PURE__*/function () {
               // because it could be stale data.
               if (cacheVersionBeforeRequest === this.cacheVersion) {
                 // Replace promise with the resolved data in the cache
-                this.cache[dataKey] = {
-                  source: 'network',
-                  data: _data
-                };
+                if (fg('platform_synced_block_patch_1')) {
+                  this.updateCache(_defineProperty({}, dataKey, _data), {
+                    strategy: 'merge',
+                    source: 'network'
+                  });
+                } else {
+                  this.cache[dataKey] = {
+                    data: _data,
+                    source: 'network'
+                  };
+                }
               }
               _context.next = 38;
               break;
@@ -316,5 +332,77 @@ export var NodeDataProvider = /*#__PURE__*/function () {
       var dataKey = this.nodeDataKey(jsonNode);
       return this.cache[dataKey];
     }
+
+    /**
+     * Updates the cache with new records using merge or replace strategies.
+     * This method should be the only way to modify the cache directly.
+     * This allow subclasses to use it when needed. e.g. abstract fetchNodesData implementation.
+     *
+     * @example
+     * ```
+     * const newRecords = {
+     *   'node-id-1': { value: 'updated data' },
+     *   'node-id-3': { value: 'new data' }
+     * };
+     * nodeDataProvider.updateCache(newRecords, { strategy: 'merge', source: 'network' });
+     * ```
+     *
+     * Supports two strategies:
+     * - 'merge' (default): Merges new records into the existing cache.
+     * - 'replace': Replaces the entire cache with the new records, invalidating any in-flight requests.
+     *
+     * @param records A map of node data keys to their corresponding data.
+     * @param options Optional settings for the update operation.
+     * @param options.strategy The strategy to use for updating the cache ('merge' or 'replace'). Defaults to 'merge'.
+     * @param options.source The source of the data being added ('ssr' or 'network'). Defaults to 'network'.
+     */
+  }, {
+    key: "updateCache",
+    value: function updateCache() {
+      var _options$strategy, _options$source;
+      var records = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+      var options = arguments.length > 1 ? arguments[1] : undefined;
+      var strategy = (_options$strategy = options === null || options === void 0 ? void 0 : options.strategy) !== null && _options$strategy !== void 0 ? _options$strategy : 'merge';
+      var source = (_options$source = options === null || options === void 0 ? void 0 : options.source) !== null && _options$source !== void 0 ? _options$source : 'network';
+      if (strategy === 'merge') {
+        for (var _i = 0, _Object$entries = Object.entries(records); _i < _Object$entries.length; _i++) {
+          var _Object$entries$_i = _slicedToArray(_Object$entries[_i], 2),
+            key = _Object$entries$_i[0],
+            data = _Object$entries$_i[1];
+          this.cache[key] = {
+            data: data,
+            source: source
+          };
+        }
+        return;
+      } else if (strategy === 'replace') {
+        // Replace the entire cache with the new records
+        // This will increase the cache version to invalidate any in-flight requests
+        this.resetCache();
+        this.cache = Object.fromEntries(Object.entries(records).map(function (_ref5) {
+          var _ref6 = _slicedToArray(_ref5, 2),
+            key = _ref6[0],
+            data = _ref6[1];
+          return [key, {
+            data: data,
+            source: source
+          }];
+        }));
+      }
+    }
+
+    /**
+     * Removes one or more entries from the cache.
+     *
+     * @param keys A single data key or array of data keys to remove from the cache.
+     */
+  }, {
+    key: "removeFromCache",
+    value: function removeFromCache(keys) {
+      var _this2 = this;
+      keys.forEach(function (key) {
+        delete _this2.cache[key];
+      });
+    }
   }]);
 }();

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

@@ -13,6 +13,7 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 type SSRData<Data> = {
     [dataKey: string]: Data;
 };
+type CacheRecords<Data> = SSRData<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:
@@ -170,5 +171,38 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, 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;
+    /**
+     * Updates the cache with new records using merge or replace strategies.
+     * This method should be the only way to modify the cache directly.
+     * This allow subclasses to use it when needed. e.g. abstract fetchNodesData implementation.
+     *
+     * @example
+     * ```
+     * const newRecords = {
+     *   'node-id-1': { value: 'updated data' },
+     *   'node-id-3': { value: 'new data' }
+     * };
+     * nodeDataProvider.updateCache(newRecords, { strategy: 'merge', source: 'network' });
+     * ```
+     *
+     * Supports two strategies:
+     * - 'merge' (default): Merges new records into the existing cache.
+     * - 'replace': Replaces the entire cache with the new records, invalidating any in-flight requests.
+     *
+     * @param records A map of node data keys to their corresponding data.
+     * @param options Optional settings for the update operation.
+     * @param options.strategy The strategy to use for updating the cache ('merge' or 'replace'). Defaults to 'merge'.
+     * @param options.source The source of the data being added ('ssr' or 'network'). Defaults to 'network'.
+     */
+    updateCache(records?: CacheRecords<Data>, options?: {
+        source?: 'ssr' | 'network';
+        strategy?: 'merge' | 'replace';
+    }): void;
+    /**
+     * Removes one or more entries from the cache.
+     *
+     * @param keys A single data key or array of data keys to remove from the cache.
+     */
+    removeFromCache(keys: string[]): void;
 }
 export {};

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

@@ -13,6 +13,7 @@ import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 type SSRData<Data> = {
     [dataKey: string]: Data;
 };
+type CacheRecords<Data> = SSRData<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:
@@ -170,5 +171,38 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, 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;
+    /**
+     * Updates the cache with new records using merge or replace strategies.
+     * This method should be the only way to modify the cache directly.
+     * This allow subclasses to use it when needed. e.g. abstract fetchNodesData implementation.
+     *
+     * @example
+     * ```
+     * const newRecords = {
+     *   'node-id-1': { value: 'updated data' },
+     *   'node-id-3': { value: 'new data' }
+     * };
+     * nodeDataProvider.updateCache(newRecords, { strategy: 'merge', source: 'network' });
+     * ```
+     *
+     * Supports two strategies:
+     * - 'merge' (default): Merges new records into the existing cache.
+     * - 'replace': Replaces the entire cache with the new records, invalidating any in-flight requests.
+     *
+     * @param records A map of node data keys to their corresponding data.
+     * @param options Optional settings for the update operation.
+     * @param options.strategy The strategy to use for updating the cache ('merge' or 'replace'). Defaults to 'merge'.
+     * @param options.source The source of the data being added ('ssr' or 'network'). Defaults to 'network'.
+     */
+    updateCache(records?: CacheRecords<Data>, options?: {
+        source?: 'ssr' | 'network';
+        strategy?: 'merge' | 'replace';
+    }): void;
+    /**
+     * Removes one or more entries from the cache.
+     *
+     * @param keys A single data key or array of data keys to remove from the cache.
+     */
+    removeFromCache(keys: string[]): void;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/node-data-provider",
-	"version": "8.0.0",
+	"version": "8.2.0",
 	"description": "Node data provider for @atlaskit/editor-core plugins and @atlaskit/renderer",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -20,11 +20,12 @@
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
 		"@atlaskit/editor-json-transformer": "^8.31.0",
-		"@atlaskit/editor-prosemirror": "^7.2.0",
+		"@atlaskit/editor-prosemirror": "^7.3.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.0.0"
+		"@atlaskit/editor-common": "^111.11.0"
 	},
 	"techstack": {
 		"@atlassian/frontend": {
@@ -49,6 +50,11 @@
 			]
 		}
 	},
+	"platform-feature-flags": {
+		"platform_synced_block_patch_1": {
+			"type": "boolean"
+		}
+	},
 	"stricter": {
 		"no-unused-dependencies": {
 			"checkDevDependencies": true