@atlaskit/node-data-provider 4.2.0 → 4.3.0

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

@@ -0,0 +1,107 @@
+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.
+ * It's a map where each key is a provider's name and the value is the {@link SsrData} for that provider.
+ * This structure is used to hydrate the client-side caches.
+ *
+ * @example
+ * {
+ *   'mentionProvider': { 'mention-1': { id: '1', name: 'John Doe' } },
+ *   'emojiProvider': { 'emoji-123': { shortName: ':smile:', representation: '😊' } }
+ * }
+ */
+type NodeDataProvidersSsrData = {
+    [providerName: string]: SsrData;
+};
+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.
+     *
+     * @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 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
+         * nodes of the same type.
+         *
+         * @default If not specified, all nodes supported by the provider will be prefetched.
+         */
+        maxNodesToPrefetch?: number;
+        /**
+         * 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;
+    }[];
+}
+/**
+ * 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,
+ *   },
+ * ];
+ *
+ * window['__SSR_EDITOR_NODE_DATA_PROVIDERS_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,
+ *          where each SSR data is a record of node data keys to the fetched data.
+ */
+export declare function prefetchNodeDataProvidersData({ providers, doc, timeout, maxNodesToVisit, }: Props): Promise<NodeDataProvidersSsrData>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/node-data-provider",
-	"version": "4.2.0",
+	"version": "4.3.0",
 	"description": "Node data provider for @atlaskit/editor-core plugins and @atlaskit/renderer",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -8,7 +8,7 @@
 		"registry": "https://registry.npmjs.org/"
 	},
 	"atlassian": {
-		"team": "Editor: Core Experiences",
+		"team": "Editor: Lego",
 		"singleton": true
 	},
 	"repository": "https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo",
@@ -24,13 +24,14 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^49.0.6",
 		"@atlaskit/adf-utils": "^19.20.0",
+		"@atlaskit/editor-json-transformer": "^8.24.0",
+		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@babel/runtime": "^7.0.0"
 	},
 	"peerDependencies": {
-		"react": "^18.2.0"
+		"@atlaskit/editor-common": "^107.12.0"
 	},
 	"devDependencies": {
-		"@atlaskit/editor-test-helpers": "workspace:^",
 		"typescript": "~5.4.2"
 	},
 	"techstack": {