@atlaskit/node-data-provider 4.5.2 → 4.6.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/node-data-provider
 
+## 4.6.0
+
+### Minor Changes
+
+- [`5763f85b421a2`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5763f85b421a2) - -
+  The new method `getCacheStatusForNode` is added to `NodeDataProvider` class to get the cache
+  status for a given node.
+  - The `CardSSR` component will start supporting `hideIconLoadingSkeleton` property for any type of
+    smart card.
+
+### Patch Changes
+
+- [`a2cd8c46a3e94`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a2cd8c46a3e94) -
+  EDITOR-1442 Bump adf-schema
+- Updated dependencies
+
+## 4.5.3
+
+### Patch Changes
+
+- [`0fdcb6f2f96fd`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/0fdcb6f2f96fd) -
+  Sorted type and interface props to improve Atlaskit docs
+- Updated dependencies
+
 ## 4.5.2
 
 ### Patch Changes

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

@@ -272,6 +272,31 @@ var NodeDataProvider = exports.NodeDataProvider = /*#__PURE__*/function () {
         }
       });
     }
+
+    /**
+     * Checks the cache for the given node and returns its status.
+     *
+     * Possible return values:
+     * - `false`: No cached data found for the node.
+     * - `'ssr'`: Data is cached from server-side rendering (SSR).
+     * - `'network'`: Data is cached from a network request.
+     *
+     * @param node The node (or its ProseMirror representation) to check in the cache.
+     * @returns The cache status: `false`, `'ssr'`, or `'network'`.
+     */
+  }, {
+    key: "getCacheStatusForNode",
+    value: function getCacheStatusForNode(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;
+      }
+      var dataKey = this.nodeDataKey(jsonNode);
+      var dataFromCache = this.cache[dataKey];
+      return dataFromCache ? dataFromCache.source : false;
+    }
   }]);
 }();
 function isPromise(value) {

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

@@ -231,6 +231,29 @@ export class NodeDataProvider {
       }
     });
   }
+
+  /**
+   * Checks the cache for the given node and returns its status.
+   *
+   * Possible return values:
+   * - `false`: No cached data found for the node.
+   * - `'ssr'`: Data is cached from server-side rendering (SSR).
+   * - `'network'`: Data is cached from a network request.
+   *
+   * @param node The node (or its ProseMirror representation) to check in the cache.
+   * @returns The cache status: `false`, `'ssr'`, or `'network'`.
+   */
+  getCacheStatusForNode(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;
+    }
+    const dataKey = this.nodeDataKey(jsonNode);
+    const dataFromCache = this.cache[dataKey];
+    return dataFromCache ? dataFromCache.source : false;
+  }
 }
 function isPromise(value) {
   return typeof value === 'object' && value !== null && 'then' in value && typeof value.then === 'function';

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

@@ -269,6 +269,31 @@ export var NodeDataProvider = /*#__PURE__*/function () {
         }
       });
     }
+
+    /**
+     * Checks the cache for the given node and returns its status.
+     *
+     * Possible return values:
+     * - `false`: No cached data found for the node.
+     * - `'ssr'`: Data is cached from server-side rendering (SSR).
+     * - `'network'`: Data is cached from a network request.
+     *
+     * @param node The node (or its ProseMirror representation) to check in the cache.
+     * @returns The cache status: `false`, `'ssr'`, or `'network'`.
+     */
+  }, {
+    key: "getCacheStatusForNode",
+    value: function getCacheStatusForNode(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;
+      }
+      var dataKey = this.nodeDataKey(jsonNode);
+      var dataFromCache = this.cache[dataKey];
+      return dataFromCache ? dataFromCache.source : false;
+    }
   }]);
 }();
 function isPromise(value) {

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

@@ -18,9 +18,9 @@ type SSRData<Data> = {
  * It can either contain an error or the fetched data.
  */
 type CallbackPayload<Data> = {
+    data?: undefined;
     /** An error that occurred while fetching data. */
     error: Error;
-    data?: undefined;
 } | {
     /** Fetched data for the node. */
     data: Data;
@@ -134,5 +134,17 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
      * @returns A promise that resolves with the node's data.
      */
     getDataAsPromise_DO_NOT_USE_OUTSIDE_MIGRATIONS(node: Node | PMNode): Promise<Data>;
+    /**
+     * Checks the cache for the given node and returns its status.
+     *
+     * Possible return values:
+     * - `false`: No cached data found for the node.
+     * - `'ssr'`: Data is cached from server-side rendering (SSR).
+     * - `'network'`: Data is cached from a network request.
+     *
+     * @param node The node (or its ProseMirror representation) to check in the cache.
+     * @returns The cache status: `false`, `'ssr'`, or `'network'`.
+     */
+    getCacheStatusForNode(node: Node | PMNode): false | 'ssr' | 'network';
 }
 export {};

package/dist/types/utils/find-nodes-to-prefetch.d.ts

@@ -1,10 +1,10 @@
 import type { JSONDocNode, JSONNode } from '@atlaskit/editor-json-transformer';
 import type { NodeDataProvider } from '../node-data-provider';
 interface ProviderWithNodes {
-    /** The provider that supports the nodes. */
-    provider: NodeDataProvider<JSONNode, unknown>;
     /** The nodes that are supported by the provider. */
     nodes: JSONNode[];
+    /** The provider that supports the nodes. */
+    provider: NodeDataProvider<JSONNode, unknown>;
 }
 /**
  * Finds nodes in the document that are supported by the given providers, up to a maximum number of nodes.
@@ -15,7 +15,7 @@ interface ProviderWithNodes {
  * @returns An array of objects, each containing a provider and the nodes that are supported by that provider.
  */
 export declare function findNodesToPrefetch(doc: JSONDocNode, providers: {
-    provider: NodeDataProvider<JSONNode, unknown>;
     maxNodesToPrefetch: number;
+    provider: NodeDataProvider<JSONNode, unknown>;
 }[], maxNodesToVisit: number): ProviderWithNodes[];
 export {};

package/dist/types/utils/prefetch-node-data-providers-data.d.ts

@@ -40,9 +40,9 @@ type SsrData = {
  */
 type NodeDataProvidersSsrData = {
     [providerName: string]: {
-        success: boolean;
-        duration: number;
         data: SsrData;
+        duration: number;
+        success: boolean;
     };
 };
 interface Props {
@@ -50,12 +50,6 @@ interface Props {
      * The document for which to prefetch data.
      */
     doc: JSONDocNode;
-    /**
-     * A global timeout in milliseconds for all fetch requests.
-     *
-     * Each provider will use the minimum of this value and its own specific timeout.
-     */
-    timeout: number;
     /**
      * The maximum number of nodes to visit when searching for nodes to prefetch.
      * This is a performance safeguard for very large documents.
@@ -68,10 +62,6 @@ interface Props {
      * individual configurations.
      */
     providers: {
-        /**
-         * The provider instance to use for prefetching.
-         */
-        provider: NodeDataProvider<JSONNode, unknown>;
         /**
          * The maximum number of nodes to prefetch for this specific provider.
          * This helps prevent performance issues with documents containing many
@@ -80,6 +70,10 @@ interface Props {
          * @default If not specified, all nodes supported by the provider will be prefetched.
          */
         maxNodesToPrefetch?: number;
+        /**
+         * The provider instance to use for prefetching.
+         */
+        provider: NodeDataProvider<JSONNode, unknown>;
         /**
          * The timeout in milliseconds for the fetch request for this specific provider.
          * If the request takes longer than this, it will be aborted and return no data.
@@ -88,6 +82,12 @@ interface Props {
          */
         timeout?: number;
     }[];
+    /**
+     * A global timeout in milliseconds for all fetch requests.
+     *
+     * Each provider will use the minimum of this value and its own specific timeout.
+     */
+    timeout: number;
 }
 /**
  * Fetches data for nodes in the document that are supported by the given providers.

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

@@ -18,9 +18,9 @@ type SSRData<Data> = {
  * It can either contain an error or the fetched data.
  */
 type CallbackPayload<Data> = {
+    data?: undefined;
     /** An error that occurred while fetching data. */
     error: Error;
-    data?: undefined;
 } | {
     /** Fetched data for the node. */
     data: Data;
@@ -134,5 +134,17 @@ export declare abstract class NodeDataProvider<Node extends JSONNode, Data> {
      * @returns A promise that resolves with the node's data.
      */
     getDataAsPromise_DO_NOT_USE_OUTSIDE_MIGRATIONS(node: Node | PMNode): Promise<Data>;
+    /**
+     * Checks the cache for the given node and returns its status.
+     *
+     * Possible return values:
+     * - `false`: No cached data found for the node.
+     * - `'ssr'`: Data is cached from server-side rendering (SSR).
+     * - `'network'`: Data is cached from a network request.
+     *
+     * @param node The node (or its ProseMirror representation) to check in the cache.
+     * @returns The cache status: `false`, `'ssr'`, or `'network'`.
+     */
+    getCacheStatusForNode(node: Node | PMNode): false | 'ssr' | 'network';
 }
 export {};

package/dist/types-ts4.5/utils/find-nodes-to-prefetch.d.ts

@@ -1,10 +1,10 @@
 import type { JSONDocNode, JSONNode } from '@atlaskit/editor-json-transformer';
 import type { NodeDataProvider } from '../node-data-provider';
 interface ProviderWithNodes {
-    /** The provider that supports the nodes. */
-    provider: NodeDataProvider<JSONNode, unknown>;
     /** The nodes that are supported by the provider. */
     nodes: JSONNode[];
+    /** The provider that supports the nodes. */
+    provider: NodeDataProvider<JSONNode, unknown>;
 }
 /**
  * Finds nodes in the document that are supported by the given providers, up to a maximum number of nodes.
@@ -15,7 +15,7 @@ interface ProviderWithNodes {
  * @returns An array of objects, each containing a provider and the nodes that are supported by that provider.
  */
 export declare function findNodesToPrefetch(doc: JSONDocNode, providers: {
-    provider: NodeDataProvider<JSONNode, unknown>;
     maxNodesToPrefetch: number;
+    provider: NodeDataProvider<JSONNode, unknown>;
 }[], maxNodesToVisit: number): ProviderWithNodes[];
 export {};

package/dist/types-ts4.5/utils/prefetch-node-data-providers-data.d.ts

@@ -40,9 +40,9 @@ type SsrData = {
  */
 type NodeDataProvidersSsrData = {
     [providerName: string]: {
-        success: boolean;
-        duration: number;
         data: SsrData;
+        duration: number;
+        success: boolean;
     };
 };
 interface Props {
@@ -50,12 +50,6 @@ interface Props {
      * The document for which to prefetch data.
      */
     doc: JSONDocNode;
-    /**
-     * A global timeout in milliseconds for all fetch requests.
-     *
-     * Each provider will use the minimum of this value and its own specific timeout.
-     */
-    timeout: number;
     /**
      * The maximum number of nodes to visit when searching for nodes to prefetch.
      * This is a performance safeguard for very large documents.
@@ -68,10 +62,6 @@ interface Props {
      * individual configurations.
      */
     providers: {
-        /**
-         * The provider instance to use for prefetching.
-         */
-        provider: NodeDataProvider<JSONNode, unknown>;
         /**
          * The maximum number of nodes to prefetch for this specific provider.
          * This helps prevent performance issues with documents containing many
@@ -80,6 +70,10 @@ interface Props {
          * @default If not specified, all nodes supported by the provider will be prefetched.
          */
         maxNodesToPrefetch?: number;
+        /**
+         * The provider instance to use for prefetching.
+         */
+        provider: NodeDataProvider<JSONNode, unknown>;
         /**
          * The timeout in milliseconds for the fetch request for this specific provider.
          * If the request takes longer than this, it will be aborted and return no data.
@@ -88,6 +82,12 @@ interface Props {
          */
         timeout?: number;
     }[];
+    /**
+     * A global timeout in milliseconds for all fetch requests.
+     *
+     * Each provider will use the minimum of this value and its own specific timeout.
+     */
+    timeout: number;
 }
 /**
  * Fetches data for nodes in the document that are supported by the given providers.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/node-data-provider",
-	"version": "4.5.2",
+	"version": "4.6.0",
 	"description": "Node data provider for @atlaskit/editor-core plugins and @atlaskit/renderer",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -18,18 +18,15 @@
 	"types": "dist/types/index.d.ts",
 	"sideEffects": false,
 	"atlaskit:src": "src/index.ts",
-	"af:exports": {
-		".": "./src/index.ts"
-	},
 	"dependencies": {
-		"@atlaskit/adf-schema": "^50.2.1",
+		"@atlaskit/adf-schema": "^50.2.3",
 		"@atlaskit/adf-utils": "^19.21.0",
-		"@atlaskit/editor-json-transformer": "^8.26.0",
+		"@atlaskit/editor-json-transformer": "^8.27.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^107.26.0"
+		"@atlaskit/editor-common": "^107.33.0"
 	},
 	"techstack": {
 		"@atlassian/frontend": {