@atlaskit/node-data-provider 12.0.13 → 12.0.15

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/node-data-provider
 
+## 12.0.15
+
+### Patch Changes
+
+- Updated dependencies
+
+## 12.0.14
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 12.0.13
 
 ### Patch Changes

package/find-nodes-to-prefetch/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/entry-points/find-nodes-to-prefetch.js",
   "module:es2019": "../dist/es2019/entry-points/find-nodes-to-prefetch.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/find-nodes-to-prefetch.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/find-nodes-to-prefetch.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/find-nodes-to-prefetch.d.ts"
 }

package/node-data-provider/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/entry-points/node-data-provider.js",
   "module:es2019": "../dist/es2019/entry-points/node-data-provider.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/node-data-provider.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/node-data-provider.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/node-data-provider.d.ts"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/node-data-provider",
-	"version": "12.0.13",
+	"version": "12.0.15",
 	"description": "Node data provider for @atlaskit/editor-core plugins and @atlaskit/renderer",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -22,7 +22,7 @@
 		"@atlaskit/editor-json-transformer": "^8.33.0",
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
-		"@atlaskit/tmp-editor-statsig": "^101.0.0",
+		"@atlaskit/tmp-editor-statsig": "^103.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {

package/prefetch-node-data-providers-data/package.json

@@ -4,12 +4,5 @@
   "module": "../dist/esm/entry-points/prefetch-node-data-providers-data.js",
   "module:es2019": "../dist/es2019/entry-points/prefetch-node-data-providers-data.js",
   "sideEffects": false,
-  "types": "../dist/types/entry-points/prefetch-node-data-providers-data.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/prefetch-node-data-providers-data.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/prefetch-node-data-providers-data.d.ts"
 }

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

@@ -1 +0,0 @@
-export { findNodesToPrefetch } from '../utils/find-nodes-to-prefetch';

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

@@ -1,2 +0,0 @@
-export { NodeDataProvider } from '../node-data-provider';
-export type { CallbackPayload } from '../node-data-provider';

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

@@ -1 +0,0 @@
-export { prefetchNodeDataProvidersData } from '../utils/prefetch-node-data-providers-data';

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

@@ -1,4 +0,0 @@
-export { NodeDataProvider } from './node-data-provider';
-export type { CallbackPayload } from './node-data-provider';
-export { findNodesToPrefetch } from './utils/find-nodes-to-prefetch';
-export { prefetchNodeDataProvidersData } from './utils/prefetch-node-data-providers-data';

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

@@ -1,214 +0,0 @@
-import type { JSONNode } from '@atlaskit/editor-json-transformer';
-import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-/**
- * 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.
- *
- * @example
- * {
- *   'node-id-1': { value: 'some data' },
- *   'node-id-2': { value: 'other data' }
- * }
- */
-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:
- * - `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.
- */
-export type CallbackPayload<Data> = {
-    data?: undefined;
-    /** An error that occurred while fetching data. */
-    error: Error;
-} | {
-    /** Fetched data for the node. */
-    data: Data;
-    error?: undefined;
-};
-/**
- * A Node Data Provider is responsible for fetching and caching data associated with specific ProseMirror nodes.
- * It supports a cache-first-then-network strategy, with initial data potentially provided via SSR.
- *
- * @template Node The specific type of JSONNode this provider supports.
- * @template Data The type of data this provider fetches and manages.
- */
-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.
-     */
-    abstract readonly name: string;
-    /**
-     * A type guard to check if a given JSONNode is supported by this provider.
-     * Used to ensure that the provider can handle the node type before attempting to fetch data.
-     *
-     * @param node The node to check.
-     * @returns `true` if the node is of the type supported by this provider, otherwise `false`.
-     */
-    abstract isNodeSupported(node: JSONNode): node is Node;
-    /**
-     * Generates a unique key for a given node to be used for caching.
-     *
-     * @param node The node for which to generate a data key.
-     * @returns A unique string key for the node's data.
-     */
-    abstract nodeDataKey(node: Node): string;
-    /**
-     * Fetches data for a batch of nodes from the network or another asynchronous source.
-     *
-     * @param nodes An array of nodes for which to fetch data.
-     * @returns A promise that resolves to an array of data corresponding to the input nodes.
-     */
-    abstract fetchNodesData(nodes: Node[]): Promise<Data[]>;
-    protected constructor();
-    /**
-     * Sets the SSR data for the provider.
-     * This pre-populates the cache with data rendered on the server, preventing redundant network requests on the client.
-     * Calling this method will invalidate the existing cache.
-     *
-     * @example
-     * ```
-     * const ssrData = window.__SSR_NODE_DATA__ || {};
-     * nodeDataProvider.setSSRData(ssrData);
-     * ```
-     *
-     * @param ssrData A map of node data keys to their corresponding data.
-     */
-    setSSRData(ssrData?: SSRData<Data>): void;
-    /**
-     * Clears all cached data.
-     * This increments the internal cache version, invalidating any pending network requests.
-     *
-     * @example
-     * ```
-     * function useMyNodeDataProvider(contentId: string) {
-     *  const nodeDataProvider = new MyNodeDataProvider();
-     *
-     *  // Reset the cache when the contentId changes (e.g., when the user navigates to a different page).
-     *  useEffect(() => {
-     *    nodeDataProvider.resetCache();
-     *  }, [contentId]);
-     *
-     *  return nodeDataProvider;
-     * }
-     * ```
-     */
-    resetCache(): void;
-    /**
-     * Fetches data for a given node using a cache-first-then-network strategy.
-     *
-     * The provided callback may be called multiple times:
-     * 1. Immediately with data from the SSR cache, if available.
-     * 2. Asynchronously with data fetched from the network.
-     *
-     * @example
-     * ```
-     * const nodeDataProvider = new MyNodeDataProvider();
-     *
-     * nodeDataProvider.getData(node, (data) => {
-     * 	console.log('Node data:', data);
-     * });
-     * ```
-     *
-     * @param node The node (or its ProseMirror representation) for which to fetch 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;
-    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.
-     *
-     * Note: This promise resolves with the *first* available data, which could be from the SSR cache or the network.
-     * It may not provide the most up-to-date data if a network fetch is in progress.
-     *
-     * Note: This method is only for migration purposes. Use {@link getData} in new code instead.
-     *
-     * @private
-     * @deprecated Don't use this method, use {@link getData} method instead.
-     *             This method is only for migration purposes.
-     *
-     * @param node The node (or its ProseMirror representation) for which to fetch 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';
-    /**
-     * 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;
-    /**
-     * Returns the keys of the cache.
-     *
-     * @returns An array of the keys of the cache.
-     */
-    getNodeDataCacheKeys(): string[];
-    /**
-     * 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/utils/find-nodes-to-prefetch.d.ts

@@ -1,22 +0,0 @@
-import type { JSONDocNode, JSONNode } from '@atlaskit/editor-json-transformer';
-import type { NodeDataProvider } from '../node-data-provider';
-interface ProviderWithNodes {
-    /** 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.
- * Uses iterative Depth-First Search (DFS) to traverse the document.
- *
- * @param doc The document to search for nodes.
- * @param providers An array of providers with their maximum nodes to prefetch.
- * @param maxNodesToVisit The maximum number of nodes to visit in the document.
- * @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: {
-    maxNodesToPrefetch: number;
-    provider: NodeDataProvider<JSONNode, unknown>;
-}[], maxNodesToVisit: number): ProviderWithNodes[];
-export {};

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

@@ -1,125 +0,0 @@
-import type { JSONDocNode, JSONNode } from '@atlaskit/editor-json-transformer';
-import type { NodeDataProvider } from '../node-data-provider';
-/**
- * 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.
- *
- * @example
- * {
- *   'node-id-1': { value: 'some data' },
- *   'node-id-2': { value: 'other data' }
- * }
- */
-type SsrData = {
-    [dataKey: string]: unknown;
-};
-/**
- * Represents the aggregated SSR data for all node data providers.
- * Each key is a provider's name, and the value contains the fetch status, duration,
- * and a map of node data keys to their prefetched data.
- *
- * @example
- * ```
- * {
- *   mentionProvider: {
- *     success: true,
- *     duration: 220,
- *     data: {
- *       'mention-1': { id: '1', name: 'John Doe' }
- *     }
- *   },
- *   emojiProvider: {
- *     success: true,
- *     duration: 110,
- *     data: {
- *       'emoji-123': { shortName: ':smile:', representation: '😊' }
- *     }
- *   }
- * }
- * ```
- */
-type NodeDataProvidersSsrData = {
-    [providerName: string]: {
-        data: SsrData;
-        duration: number;
-        success: boolean;
-    };
-};
-interface Props {
-    /**
-     * The document for which to prefetch data.
-     */
-    doc: JSONDocNode;
-    /**
-     * The maximum number of nodes to visit when searching for nodes to prefetch.
-     * This is a performance safeguard for very large documents.
-     *
-     * @default If not specified, the entire document will be traversed.
-     */
-    maxNodesToVisit?: number;
-    /**
-     * A list of node data providers to use for prefetching, along with their
-     * individual configurations.
-     */
-    providers: {
-        /**
-         * The maximum number of nodes to prefetch for this specific provider.
-         * This helps prevent performance issues with documents containing many
-         * nodes of the same type.
-         *
-         * @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.
-         *
-         * @default If not specified, the global timeout will be used.
-         */
-        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.
- * This function will traverse the document and call the `fetchData` method for each node that is supported by the providers.
- *
- * @example
- * ```
- * const doc = JSON.parse('{"type": "doc", "content": [...] }');
- * const providers = [
- *   {
- *     provider: new EditorCardProvider(),
- *  	  maxNodesToPrefetch: 10,
- *  	  timeout: 500,
- *  	},
- *   {
- *     provider: new EditorMentionsProvider(),
- *     maxNodesToPrefetch: 50,
- *  	  timeout: 500,
- *   },
- * ];
- *
- * const data = await prefetchNodeDataProvidersData({
- *   providers,
- *   doc,
- *   timeout: 1_000,
- *   maxNodesToVisit: 2_000
- * });
- * ```
- *
- * @param props The properties for prefetching node data.
- * @returns Record of provider names to their respective SSR data,
- *          success status, and duration of the fetch operation.
- */
-export declare function prefetchNodeDataProvidersData({ providers, doc, timeout, maxNodesToVisit, }: Props): Promise<NodeDataProvidersSsrData>;
-export {};