@atlaskit/editor-card-provider 6.3.4 → 6.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlaskit/editor-card-provider
 
+## 6.4.0
+
+### Minor Changes
+
+- [`506d872ef2503`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/506d872ef2503) -
+  Add smartlink response caching to browser storage to reduce layoutshift on transition and page
+  load
+
+### Patch Changes
+
+- Updated dependencies
+
+## 6.3.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 6.3.4
 
 ### Patch Changes

package/dist/cjs/index.js

@@ -9,10 +9,17 @@ Object.defineProperty(exports, "EditorCardProvider", {
     return _provider.EditorCardProvider;
   }
 });
+Object.defineProperty(exports, "SmartCardLocalCacheClient", {
+  enumerable: true,
+  get: function get() {
+    return _smartCardLocalCacheClient.SmartCardLocalCacheClient;
+  }
+});
 Object.defineProperty(exports, "editorCardProvider", {
   enumerable: true,
   get: function get() {
     return _provider.editorCardProvider;
   }
 });
-var _provider = require("./provider");
+var _provider = require("./provider");
+var _smartCardLocalCacheClient = require("./smart-card-local-cache-client");

package/dist/cjs/provider.js

@@ -13,6 +13,8 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
+var _get2 = _interopRequireDefault(require("@babel/runtime/helpers/get"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _setPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/setPrototypeOf"));
 var _linkExtractors = require("@atlaskit/link-extractors");
@@ -24,8 +26,10 @@ var _transformer = require("./transformer");
 var _linkProvider = require("@atlaskit/link-provider");
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _api = require("./api");
+var _smartCardLocalCacheClient = require("./smart-card-local-cache-client");
 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; })(); }
+function _superPropGet(t, o, e, r) { var p = (0, _get2.default)((0, _getPrototypeOf2.default)(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
 function _wrapRegExp() { _wrapRegExp = function _wrapRegExp(e, r) { return new BabelRegExp(e, void 0, r); }; var e = RegExp.prototype, r = new WeakMap(); function BabelRegExp(e, t, p) { var o = RegExp(e, t); return r.set(o, p || r.get(e)), (0, _setPrototypeOf2.default)(o, BabelRegExp.prototype); } function buildGroups(e, t) { var p = r.get(t); return Object.keys(p).reduce(function (r, t) { var o = p[t]; if ("number" == typeof o) r[t] = e[o];else { for (var i = 0; void 0 === e[o[i]] && i + 1 < o.length;) i++; r[t] = e[o[i]]; } return r; }, Object.create(null)); } return (0, _inherits2.default)(BabelRegExp, RegExp), BabelRegExp.prototype.exec = function (r) { var t = e.exec.call(this, r); if (t) { t.groups = buildGroups(t, this); var p = t.indices; p && (p.groups = buildGroups(p, this)); } return t; }, BabelRegExp.prototype[Symbol.replace] = function (t, p) { if ("string" == typeof p) { var o = r.get(this); return e[Symbol.replace].call(this, t, p.replace(/\$<([^>]+)(>|$)/g, function (e, r, t) { if ("" === t) return e; var p = o[r]; return Array.isArray(p) ? "$" + p.join("$") : "number" == typeof p ? "$" + p : ""; })); } if ("function" == typeof p) { var i = this; return e[Symbol.replace].call(this, t, function () { var e = arguments; return "object" != _typeof(e[e.length - 1]) && (e = [].slice.call(e)).push(buildGroups(e, i)), p.apply(this, e); }); } return e[Symbol.replace].call(this, t, p); }, _wrapRegExp.apply(this, arguments); } /* eslint-disable require-unicode-regexp,prefer-regex-literals */
 var BATCH_WAIT_TIME = 50;
 
@@ -137,6 +141,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
     var _this;
     (0, _classCallCheck2.default)(this, EditorCardProvider);
     _this = _callSuper(this, EditorCardProvider);
+    (0, _defineProperty2.default)(_this, "smartCardLocalCacheClient", new _smartCardLocalCacheClient.SmartCardLocalCacheClient());
     _this.name = 'editorCardProvider';
     _this.baseUrl = baseUrlOverride || (0, _linkingCommon.getBaseUrl)(envKey);
     _this.resolverUrl = (0, _linkingCommon.getResolverUrl)(envKey, baseUrlOverride);
@@ -160,6 +165,36 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
   }
   (0, _inherits2.default)(EditorCardProvider, _ref);
   return (0, _createClass2.default)(EditorCardProvider, [{
+    key: "getData",
+    value: function getData(node, callback) {
+      var _this2 = this;
+      if ((0, _expValEquals.expValEquals)('platform_editor_smartlink_local_cache', 'isEnabled', true) === false) {
+        // if local cache feature flag is disabled, fall back to the base implementation
+        return _superPropGet(EditorCardProvider, "getData", this, 3)([node, callback]);
+      }
+      var jsonNode = 'toJSON' in node ? node.toJSON() : node;
+      if (!this.isNodeSupported(jsonNode)) {
+        return;
+      }
+
+      // if we can load a response from cache, use it first
+      var key = this.nodeDataKey(jsonNode);
+      var details = this.smartCardLocalCacheClient.getItem(key);
+      if (details) {
+        callback({
+          data: details
+        });
+      }
+
+      // fetch the latest data async and update the cache
+      this.getDataAsync(node, function (payload) {
+        if (payload.data && !payload.error) {
+          _this2.smartCardLocalCacheClient.setItem(key, payload.data);
+        }
+        callback(payload);
+      });
+    }
+  }, {
     key: "nodeDataKey",
     value: function nodeDataKey(node) {
       // We can use URL as a key here, because CardClient returns the same data for the same URL
@@ -169,10 +204,10 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
   }, {
     key: "fetchNodesData",
     value: function fetchNodesData(nodes) {
-      var _this2 = this;
+      var _this3 = this;
       var promises = nodes.map(function (node) {
         var url = node.attrs.url;
-        return _this2.cardClient.fetchData(url);
+        return _this3.cardClient.fetchData(url);
       });
       return Promise.all(promises);
     }
@@ -396,7 +431,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
     value: function () {
       var _findUserPreference = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee7(url) {
         var _this$providersData,
-          _this3 = this;
+          _this4 = this;
         var userPreferences, defaultAppearance, appearances, allMatchedLabeledAppearances, longestMatchedLabeledAppearance;
         return _regenerator.default.wrap(function _callee7$(_context7) {
           while (1) switch (_context7.prev = _context7.next) {
@@ -416,7 +451,7 @@ var EditorCardProvider = exports.EditorCardProvider = /*#__PURE__*/function (_re
               defaultAppearance = userPreferences.defaultAppearance, appearances = userPreferences.appearances;
               allMatchedLabeledAppearances = appearances.filter(function (_ref2) {
                 var urlSegment = _ref2.urlSegment;
-                return _this3.doesUrlMatchPath(urlSegment, url);
+                return _this4.doesUrlMatchPath(urlSegment, url);
               });
               if (!(allMatchedLabeledAppearances.length > 0)) {
                 _context7.next = 10;

package/dist/cjs/smart-card-local-cache-client.js

@@ -0,0 +1,86 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SmartCardLocalCacheClient = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _storageClient = require("@atlaskit/frontend-utilities/storage-client");
+var SMART_CARD_CACHE_CLIENT_KEY = 'smart-card-url-data';
+var SMART_CARD_CACHE_KEY = 'response-cache';
+var SMART_CARD_CACHE_DEFAULT_MAX_ITEMS = 100;
+var SmartCardLocalCacheClient = exports.SmartCardLocalCacheClient = /*#__PURE__*/(0, _createClass2.default)(function SmartCardLocalCacheClient() {
+  var _this = this;
+  var maxItems = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : SMART_CARD_CACHE_DEFAULT_MAX_ITEMS;
+  (0, _classCallCheck2.default)(this, SmartCardLocalCacheClient);
+  (0, _defineProperty2.default)(this, "storageClient", new _storageClient.StorageClient(SMART_CARD_CACHE_CLIENT_KEY, {
+    storageEngine: 'sessionStorage'
+  }));
+  /**
+   * Retrieves the entire cache object from storage
+   * @returns The entire cache object
+   */
+  (0, _defineProperty2.default)(this, "getCache", function () {
+    var stored = _this.storageClient.getItem(SMART_CARD_CACHE_KEY, {
+      useExpiredItem: true
+    });
+    var persistentCache = stored ? JSON.parse(stored) : {};
+    return persistentCache;
+  });
+  /**
+   * Caches the SmartLinkResponse against the provided url in storage
+   * @param url The url (key) to store the response against
+   * @param response The SmartLinkResponse to be cached in storage
+   */
+  (0, _defineProperty2.default)(this, "setItem", function (url, response) {
+    var newCache = _this.getCache();
+
+    // Add or update the item in the cache with current timestamp
+    newCache[url] = {
+      data: response,
+      timestamp: Date.now()
+    };
+
+    // Apply FIFO behavior if cache exceeds maxItems
+    var cacheKeys = Object.keys(newCache);
+    if (cacheKeys.length > _this.maxItems) {
+      // Sort keys by timestamp (oldest first) and remove the oldest items
+      var sortedKeys = cacheKeys.sort(function (a, b) {
+        return newCache[a].timestamp - newCache[b].timestamp;
+      });
+      var itemsToRemove = cacheKeys.length - _this.maxItems;
+      var keysToRemove = sortedKeys.slice(0, itemsToRemove);
+      keysToRemove.forEach(function (key) {
+        delete newCache[key];
+      });
+    }
+    _this.storageClient.setItemWithExpiry(SMART_CARD_CACHE_KEY, JSON.stringify(newCache));
+  });
+  /**
+   * Retrieves the cached SmartLinkResponse for the provided url from storage (if it exists)
+   * @param url The url (key) to retrieve the cached response for
+   * @returns The cached SmartLinkResponse if it exists, else undefined
+   */
+  (0, _defineProperty2.default)(this, "getItem", function (url) {
+    var _persistentCache$url;
+    if (!url) {
+      return;
+    }
+    var persistentCache = _this.getCache();
+    var response = persistentCache === null || persistentCache === void 0 || (_persistentCache$url = persistentCache[url]) === null || _persistentCache$url === void 0 ? void 0 : _persistentCache$url.data;
+    return response;
+  });
+  /**
+   * Checks if a cached entry exists for the provided url in storage
+   * @param url The url (key) to check for existence in the cache
+   * @returns True if a cached entry exists, else false
+   */
+  (0, _defineProperty2.default)(this, "isUrlInCache", function (url) {
+    var persistentCache = _this.getCache();
+    return persistentCache ? url in persistentCache : false;
+  });
+  this.maxItems = maxItems;
+});

package/dist/es2019/index.js

@@ -1,4 +1,5 @@
 // Disable no-re-export rule for entry point files
 /* eslint-disable @atlaskit/editor/no-re-export */
 
-export { EditorCardProvider, editorCardProvider } from './provider';
+export { EditorCardProvider, editorCardProvider } from './provider';
+export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

package/dist/es2019/provider.js

@@ -1,3 +1,4 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 /* eslint-disable require-unicode-regexp,prefer-regex-literals */
 
 import { extractSmartLinkEmbed } from '@atlaskit/link-extractors';
@@ -9,6 +10,7 @@ import { Transformer } from './transformer';
 import { CardClient } from '@atlaskit/link-provider';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { request } from './api';
+import { SmartCardLocalCacheClient } from './smart-card-local-cache-client';
 const BATCH_WAIT_TIME = 50;
 
 // Check if it is matching a Jira Roadmaps or Jira Timeline url
@@ -70,6 +72,7 @@ export const isJiraWorkItem = url => /\/browse\/((?:\w+)-(?:\d+))/i.test(url);
 export class EditorCardProvider extends NodeDataProvider {
   constructor(envKey, baseUrlOverride, product, onResolve, customCardClient) {
     super();
+    _defineProperty(this, "smartCardLocalCacheClient", new SmartCardLocalCacheClient());
     this.name = 'editorCardProvider';
     this.baseUrl = baseUrlOverride || getBaseUrl(envKey);
     this.resolverUrl = getResolverUrl(envKey, baseUrlOverride);
@@ -86,6 +89,33 @@ export class EditorCardProvider extends NodeDataProvider {
       this.cardClient.setProduct(product);
     }
   }
+  getData(node, callback) {
+    if (expValEquals('platform_editor_smartlink_local_cache', 'isEnabled', true) === false) {
+      // if local cache feature flag is disabled, fall back to the base implementation
+      return super.getData(node, callback);
+    }
+    const jsonNode = 'toJSON' in node ? node.toJSON() : node;
+    if (!this.isNodeSupported(jsonNode)) {
+      return;
+    }
+
+    // if we can load a response from cache, use it first
+    const key = this.nodeDataKey(jsonNode);
+    const details = this.smartCardLocalCacheClient.getItem(key);
+    if (details) {
+      callback({
+        data: details
+      });
+    }
+
+    // fetch the latest data async and update the cache
+    this.getDataAsync(node, payload => {
+      if (payload.data && !payload.error) {
+        this.smartCardLocalCacheClient.setItem(key, payload.data);
+      }
+      callback(payload);
+    });
+  }
   nodeDataKey(node) {
     // We can use URL as a key here, because CardClient returns the same data for the same URL
     // regardless of the type of card (inline, block, embed).

package/dist/es2019/smart-card-local-cache-client.js

@@ -0,0 +1,74 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { StorageClient } from '@atlaskit/frontend-utilities/storage-client';
+const SMART_CARD_CACHE_CLIENT_KEY = 'smart-card-url-data';
+const SMART_CARD_CACHE_KEY = 'response-cache';
+const SMART_CARD_CACHE_DEFAULT_MAX_ITEMS = 100;
+export class SmartCardLocalCacheClient {
+  constructor(maxItems = SMART_CARD_CACHE_DEFAULT_MAX_ITEMS) {
+    _defineProperty(this, "storageClient", new StorageClient(SMART_CARD_CACHE_CLIENT_KEY, {
+      storageEngine: 'sessionStorage'
+    }));
+    /**
+     * Retrieves the entire cache object from storage
+     * @returns The entire cache object
+     */
+    _defineProperty(this, "getCache", () => {
+      const stored = this.storageClient.getItem(SMART_CARD_CACHE_KEY, {
+        useExpiredItem: true
+      });
+      const persistentCache = stored ? JSON.parse(stored) : {};
+      return persistentCache;
+    });
+    /**
+     * Caches the SmartLinkResponse against the provided url in storage
+     * @param url The url (key) to store the response against
+     * @param response The SmartLinkResponse to be cached in storage
+     */
+    _defineProperty(this, "setItem", (url, response) => {
+      const newCache = this.getCache();
+
+      // Add or update the item in the cache with current timestamp
+      newCache[url] = {
+        data: response,
+        timestamp: Date.now()
+      };
+
+      // Apply FIFO behavior if cache exceeds maxItems
+      const cacheKeys = Object.keys(newCache);
+      if (cacheKeys.length > this.maxItems) {
+        // Sort keys by timestamp (oldest first) and remove the oldest items
+        const sortedKeys = cacheKeys.sort((a, b) => newCache[a].timestamp - newCache[b].timestamp);
+        const itemsToRemove = cacheKeys.length - this.maxItems;
+        const keysToRemove = sortedKeys.slice(0, itemsToRemove);
+        keysToRemove.forEach(key => {
+          delete newCache[key];
+        });
+      }
+      this.storageClient.setItemWithExpiry(SMART_CARD_CACHE_KEY, JSON.stringify(newCache));
+    });
+    /**
+     * Retrieves the cached SmartLinkResponse for the provided url from storage (if it exists)
+     * @param url The url (key) to retrieve the cached response for
+     * @returns The cached SmartLinkResponse if it exists, else undefined
+     */
+    _defineProperty(this, "getItem", url => {
+      var _persistentCache$url;
+      if (!url) {
+        return;
+      }
+      const persistentCache = this.getCache();
+      const response = persistentCache === null || persistentCache === void 0 ? void 0 : (_persistentCache$url = persistentCache[url]) === null || _persistentCache$url === void 0 ? void 0 : _persistentCache$url.data;
+      return response;
+    });
+    /**
+     * Checks if a cached entry exists for the provided url in storage
+     * @param url The url (key) to check for existence in the cache
+     * @returns True if a cached entry exists, else false
+     */
+    _defineProperty(this, "isUrlInCache", url => {
+      const persistentCache = this.getCache();
+      return persistentCache ? url in persistentCache : false;
+    });
+    this.maxItems = maxItems;
+  }
+}

package/dist/esm/index.js

@@ -1,4 +1,5 @@
 // Disable no-re-export rule for entry point files
 /* eslint-disable @atlaskit/editor/no-re-export */
 
-export { EditorCardProvider, editorCardProvider } from './provider';
+export { EditorCardProvider, editorCardProvider } from './provider';
+export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

package/dist/esm/provider.js

@@ -5,11 +5,14 @@ import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
 import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _get from "@babel/runtime/helpers/get";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _setPrototypeOf from "@babel/runtime/helpers/setPrototypeOf";
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(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; })(); }
+function _superPropGet(t, o, e, r) { var p = _get(_getPrototypeOf(1 & r ? t.prototype : t), o, e); return 2 & r && "function" == typeof p ? function (t) { return p.apply(e, t); } : p; }
 function _wrapRegExp() { _wrapRegExp = function _wrapRegExp(e, r) { return new BabelRegExp(e, void 0, r); }; var e = RegExp.prototype, r = new WeakMap(); function BabelRegExp(e, t, p) { var o = RegExp(e, t); return r.set(o, p || r.get(e)), _setPrototypeOf(o, BabelRegExp.prototype); } function buildGroups(e, t) { var p = r.get(t); return Object.keys(p).reduce(function (r, t) { var o = p[t]; if ("number" == typeof o) r[t] = e[o];else { for (var i = 0; void 0 === e[o[i]] && i + 1 < o.length;) i++; r[t] = e[o[i]]; } return r; }, Object.create(null)); } return _inherits(BabelRegExp, RegExp), BabelRegExp.prototype.exec = function (r) { var t = e.exec.call(this, r); if (t) { t.groups = buildGroups(t, this); var p = t.indices; p && (p.groups = buildGroups(p, this)); } return t; }, BabelRegExp.prototype[Symbol.replace] = function (t, p) { if ("string" == typeof p) { var o = r.get(this); return e[Symbol.replace].call(this, t, p.replace(/\$<([^>]+)(>|$)/g, function (e, r, t) { if ("" === t) return e; var p = o[r]; return Array.isArray(p) ? "$" + p.join("$") : "number" == typeof p ? "$" + p : ""; })); } if ("function" == typeof p) { var i = this; return e[Symbol.replace].call(this, t, function () { var e = arguments; return "object" != _typeof(e[e.length - 1]) && (e = [].slice.call(e)).push(buildGroups(e, i)), p.apply(this, e); }); } return e[Symbol.replace].call(this, t, p); }, _wrapRegExp.apply(this, arguments); }
 /* eslint-disable require-unicode-regexp,prefer-regex-literals */
 
@@ -22,6 +25,7 @@ import { Transformer } from './transformer';
 import { CardClient } from '@atlaskit/link-provider';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { request } from './api';
+import { SmartCardLocalCacheClient } from './smart-card-local-cache-client';
 var BATCH_WAIT_TIME = 50;
 
 // Check if it is matching a Jira Roadmaps or Jira Timeline url
@@ -132,6 +136,7 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
     var _this;
     _classCallCheck(this, EditorCardProvider);
     _this = _callSuper(this, EditorCardProvider);
+    _defineProperty(_this, "smartCardLocalCacheClient", new SmartCardLocalCacheClient());
     _this.name = 'editorCardProvider';
     _this.baseUrl = baseUrlOverride || getBaseUrl(envKey);
     _this.resolverUrl = getResolverUrl(envKey, baseUrlOverride);
@@ -155,6 +160,36 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
   }
   _inherits(EditorCardProvider, _ref);
   return _createClass(EditorCardProvider, [{
+    key: "getData",
+    value: function getData(node, callback) {
+      var _this2 = this;
+      if (expValEquals('platform_editor_smartlink_local_cache', 'isEnabled', true) === false) {
+        // if local cache feature flag is disabled, fall back to the base implementation
+        return _superPropGet(EditorCardProvider, "getData", this, 3)([node, callback]);
+      }
+      var jsonNode = 'toJSON' in node ? node.toJSON() : node;
+      if (!this.isNodeSupported(jsonNode)) {
+        return;
+      }
+
+      // if we can load a response from cache, use it first
+      var key = this.nodeDataKey(jsonNode);
+      var details = this.smartCardLocalCacheClient.getItem(key);
+      if (details) {
+        callback({
+          data: details
+        });
+      }
+
+      // fetch the latest data async and update the cache
+      this.getDataAsync(node, function (payload) {
+        if (payload.data && !payload.error) {
+          _this2.smartCardLocalCacheClient.setItem(key, payload.data);
+        }
+        callback(payload);
+      });
+    }
+  }, {
     key: "nodeDataKey",
     value: function nodeDataKey(node) {
       // We can use URL as a key here, because CardClient returns the same data for the same URL
@@ -164,10 +199,10 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
   }, {
     key: "fetchNodesData",
     value: function fetchNodesData(nodes) {
-      var _this2 = this;
+      var _this3 = this;
       var promises = nodes.map(function (node) {
         var url = node.attrs.url;
-        return _this2.cardClient.fetchData(url);
+        return _this3.cardClient.fetchData(url);
       });
       return Promise.all(promises);
     }
@@ -391,7 +426,7 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
     value: function () {
       var _findUserPreference = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(url) {
         var _this$providersData,
-          _this3 = this;
+          _this4 = this;
         var userPreferences, defaultAppearance, appearances, allMatchedLabeledAppearances, longestMatchedLabeledAppearance;
         return _regeneratorRuntime.wrap(function _callee7$(_context7) {
           while (1) switch (_context7.prev = _context7.next) {
@@ -411,7 +446,7 @@ export var EditorCardProvider = /*#__PURE__*/function (_ref) {
               defaultAppearance = userPreferences.defaultAppearance, appearances = userPreferences.appearances;
               allMatchedLabeledAppearances = appearances.filter(function (_ref2) {
                 var urlSegment = _ref2.urlSegment;
-                return _this3.doesUrlMatchPath(urlSegment, url);
+                return _this4.doesUrlMatchPath(urlSegment, url);
               });
               if (!(allMatchedLabeledAppearances.length > 0)) {
                 _context7.next = 10;

package/dist/esm/smart-card-local-cache-client.js

@@ -0,0 +1,79 @@
+import _createClass from "@babel/runtime/helpers/createClass";
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { StorageClient } from '@atlaskit/frontend-utilities/storage-client';
+var SMART_CARD_CACHE_CLIENT_KEY = 'smart-card-url-data';
+var SMART_CARD_CACHE_KEY = 'response-cache';
+var SMART_CARD_CACHE_DEFAULT_MAX_ITEMS = 100;
+export var SmartCardLocalCacheClient = /*#__PURE__*/_createClass(function SmartCardLocalCacheClient() {
+  var _this = this;
+  var maxItems = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : SMART_CARD_CACHE_DEFAULT_MAX_ITEMS;
+  _classCallCheck(this, SmartCardLocalCacheClient);
+  _defineProperty(this, "storageClient", new StorageClient(SMART_CARD_CACHE_CLIENT_KEY, {
+    storageEngine: 'sessionStorage'
+  }));
+  /**
+   * Retrieves the entire cache object from storage
+   * @returns The entire cache object
+   */
+  _defineProperty(this, "getCache", function () {
+    var stored = _this.storageClient.getItem(SMART_CARD_CACHE_KEY, {
+      useExpiredItem: true
+    });
+    var persistentCache = stored ? JSON.parse(stored) : {};
+    return persistentCache;
+  });
+  /**
+   * Caches the SmartLinkResponse against the provided url in storage
+   * @param url The url (key) to store the response against
+   * @param response The SmartLinkResponse to be cached in storage
+   */
+  _defineProperty(this, "setItem", function (url, response) {
+    var newCache = _this.getCache();
+
+    // Add or update the item in the cache with current timestamp
+    newCache[url] = {
+      data: response,
+      timestamp: Date.now()
+    };
+
+    // Apply FIFO behavior if cache exceeds maxItems
+    var cacheKeys = Object.keys(newCache);
+    if (cacheKeys.length > _this.maxItems) {
+      // Sort keys by timestamp (oldest first) and remove the oldest items
+      var sortedKeys = cacheKeys.sort(function (a, b) {
+        return newCache[a].timestamp - newCache[b].timestamp;
+      });
+      var itemsToRemove = cacheKeys.length - _this.maxItems;
+      var keysToRemove = sortedKeys.slice(0, itemsToRemove);
+      keysToRemove.forEach(function (key) {
+        delete newCache[key];
+      });
+    }
+    _this.storageClient.setItemWithExpiry(SMART_CARD_CACHE_KEY, JSON.stringify(newCache));
+  });
+  /**
+   * Retrieves the cached SmartLinkResponse for the provided url from storage (if it exists)
+   * @param url The url (key) to retrieve the cached response for
+   * @returns The cached SmartLinkResponse if it exists, else undefined
+   */
+  _defineProperty(this, "getItem", function (url) {
+    var _persistentCache$url;
+    if (!url) {
+      return;
+    }
+    var persistentCache = _this.getCache();
+    var response = persistentCache === null || persistentCache === void 0 || (_persistentCache$url = persistentCache[url]) === null || _persistentCache$url === void 0 ? void 0 : _persistentCache$url.data;
+    return response;
+  });
+  /**
+   * Checks if a cached entry exists for the provided url in storage
+   * @param url The url (key) to check for existence in the cache
+   * @returns True if a cached entry exists, else false
+   */
+  _defineProperty(this, "isUrlInCache", function (url) {
+    var persistentCache = _this.getCache();
+    return persistentCache ? url in persistentCache : false;
+  });
+  this.maxItems = maxItems;
+});

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export { EditorCardProvider, editorCardProvider } from './provider';
+export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

package/dist/types/provider.d.ts

@@ -1,4 +1,6 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer';
+import type { CallbackPayload } from '@atlaskit/node-data-provider';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import { type BlockCardAdf, type EmbedCardAdf, type CardAdf, type InlineCardAdf, type CardAppearance, type DatasourceAdf, type ProductType, type EnvironmentsKeys } from '@atlaskit/linking-common';
 import { type CardProvider } from './types';
@@ -15,8 +17,10 @@ export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonL
     private transformer;
     private providersLoader;
     private cardClient;
+    private smartCardLocalCacheClient;
     private onResolve;
     constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient);
+    getData(node: CardNode | PMNode, callback: (payload: CallbackPayload<JsonLd.Response>) => void): void;
     nodeDataKey(node: CardNode): string;
     fetchNodesData(nodes: CardNode[]): Promise<JsonLd.Response[]>;
     isNodeSupported(node: JSONNode): node is CardNode;

package/dist/types/smart-card-local-cache-client.d.ts

@@ -0,0 +1,34 @@
+import type { SmartLinkResponse } from '@atlaskit/linking-types';
+type CacheEntry = {
+    data: SmartLinkResponse;
+    timestamp: number;
+};
+export declare class SmartCardLocalCacheClient {
+    private readonly storageClient;
+    private maxItems;
+    constructor(maxItems?: number);
+    /**
+     * Retrieves the entire cache object from storage
+     * @returns The entire cache object
+     */
+    getCache: () => Record<string, CacheEntry>;
+    /**
+     * Caches the SmartLinkResponse against the provided url in storage
+     * @param url The url (key) to store the response against
+     * @param response The SmartLinkResponse to be cached in storage
+     */
+    setItem: (url: string, response: SmartLinkResponse) => void;
+    /**
+     * Retrieves the cached SmartLinkResponse for the provided url from storage (if it exists)
+     * @param url The url (key) to retrieve the cached response for
+     * @returns The cached SmartLinkResponse if it exists, else undefined
+     */
+    getItem: (url: string | undefined) => SmartLinkResponse | undefined;
+    /**
+     * Checks if a cached entry exists for the provided url in storage
+     * @param url The url (key) to check for existence in the cache
+     * @returns True if a cached entry exists, else false
+     */
+    isUrlInCache: (url: string) => boolean;
+}
+export {};

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

@@ -1 +1,2 @@
 export { EditorCardProvider, editorCardProvider } from './provider';
+export { SmartCardLocalCacheClient } from './smart-card-local-cache-client';

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

@@ -1,4 +1,6 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer';
+import type { CallbackPayload } from '@atlaskit/node-data-provider';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import { type BlockCardAdf, type EmbedCardAdf, type CardAdf, type InlineCardAdf, type CardAppearance, type DatasourceAdf, type ProductType, type EnvironmentsKeys } from '@atlaskit/linking-common';
 import { type CardProvider } from './types';
@@ -15,8 +17,10 @@ export declare class EditorCardProvider extends NodeDataProvider<CardNode, JsonL
     private transformer;
     private providersLoader;
     private cardClient;
+    private smartCardLocalCacheClient;
     private onResolve;
     constructor(envKey?: EnvironmentsKeys, baseUrlOverride?: string, product?: ProductType, onResolve?: (url: string) => void, customCardClient?: CardClient);
+    getData(node: CardNode | PMNode, callback: (payload: CallbackPayload<JsonLd.Response>) => void): void;
     nodeDataKey(node: CardNode): string;
     fetchNodesData(nodes: CardNode[]): Promise<JsonLd.Response[]>;
     isNodeSupported(node: JSONNode): node is CardNode;

package/dist/types-ts4.5/smart-card-local-cache-client.d.ts

@@ -0,0 +1,34 @@
+import type { SmartLinkResponse } from '@atlaskit/linking-types';
+type CacheEntry = {
+    data: SmartLinkResponse;
+    timestamp: number;
+};
+export declare class SmartCardLocalCacheClient {
+    private readonly storageClient;
+    private maxItems;
+    constructor(maxItems?: number);
+    /**
+     * Retrieves the entire cache object from storage
+     * @returns The entire cache object
+     */
+    getCache: () => Record<string, CacheEntry>;
+    /**
+     * Caches the SmartLinkResponse against the provided url in storage
+     * @param url The url (key) to store the response against
+     * @param response The SmartLinkResponse to be cached in storage
+     */
+    setItem: (url: string, response: SmartLinkResponse) => void;
+    /**
+     * Retrieves the cached SmartLinkResponse for the provided url from storage (if it exists)
+     * @param url The url (key) to retrieve the cached response for
+     * @returns The cached SmartLinkResponse if it exists, else undefined
+     */
+    getItem: (url: string | undefined) => SmartLinkResponse | undefined;
+    /**
+     * Checks if a cached entry exists for the provided url in storage
+     * @param url The url (key) to check for existence in the cache
+     * @returns True if a cached entry exists, else false
+     */
+    isUrlInCache: (url: string) => boolean;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-card-provider",
-	"version": "6.3.4",
+	"version": "6.4.0",
 	"description": "Contains the EditorCardProvider, for determining smart card behaviour in the editor.",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -31,14 +31,15 @@
 	"dependencies": {
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/feature-gate-js-client": "^5.5.0",
+		"@atlaskit/frontend-utilities": "^3.2.0",
 		"@atlaskit/json-ld-types": "^1.4.0",
 		"@atlaskit/link-client-extension": "^6.0.0",
 		"@atlaskit/link-extractors": "^2.4.0",
 		"@atlaskit/linking-common": "^9.9.0",
 		"@atlaskit/linking-types": "^14.2.0",
-		"@atlaskit/node-data-provider": "^8.1.0",
+		"@atlaskit/node-data-provider": "^8.3.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^20.0.0",
+		"@atlaskit/tmp-editor-statsig": "^21.2.0",
 		"@babel/runtime": "^7.0.0",
 		"dataloader": "^2.1.0"
 	},