@atlaskit/editor-synced-block-renderer 5.6.7 → 5.7.1

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-synced-block-renderer
 
+## 5.7.1
+
+### Patch Changes
+
+- [`764672ccc7992`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/764672ccc7992) -
+  EDITOR-4049 Add support for prefetching of synced blocks data to synced block provider.
+- Updated dependencies
+
+## 5.7.0
+
+### Minor Changes
+
+- [`7daf10b49fce7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/7daf10b49fce7) -
+  Pass in event handlers to the sync block options
+
 ## 5.6.7
 
 ### Patch Changes

package/dist/cjs/ui/AKRendererWrapper.js

@@ -89,6 +89,7 @@ var AKRendererWrapper = exports.AKRendererWrapper = /*#__PURE__*/(0, _react.memo
     allowUgcScrubber = _ref4.allowUgcScrubber,
     allowWrapCodeBlock = _ref4.allowWrapCodeBlock,
     emojiResourceConfig = _ref4.emojiResourceConfig,
+    eventHandlers = _ref4.eventHandlers,
     media = _ref4.media,
     smartLinks = _ref4.smartLinks,
     stickyHeaders = _ref4.stickyHeaders;
@@ -133,6 +134,7 @@ var AKRendererWrapper = exports.AKRendererWrapper = /*#__PURE__*/(0, _react.memo
     allowUgcScrubber: allowUgcScrubber,
     allowWrapCodeBlock: allowWrapCodeBlock,
     emojiResourceConfig: emojiResourceConfig,
+    eventHandlers: (0, _platformFeatureFlags.fg)('platform_synced_block_patch_1') ? eventHandlers : undefined,
     media: media,
     smartLinks: smartLinks,
     stickyHeaders: stickyHeaders

package/dist/cjs/useSyncedBlockNodeComponent.js

@@ -27,7 +27,8 @@ var useMemoizedSyncedBlockNodeComponent = exports.useMemoizedSyncedBlockNodeComp
     syncBlockProvider = _ref.syncBlockProvider,
     syncBlockRendererOptions = _ref.syncBlockRendererOptions,
     fireAnalyticsEvent = _ref.fireAnalyticsEvent,
-    getSSRData = _ref.getSSRData;
+    getSSRData = _ref.getSSRData,
+    getPrefetchedData = _ref.getPrefetchedData;
   var syncBlockStoreManager = (0, _editorSyncedBlockProvider.useMemoizedSyncBlockStoreManager)(syncBlockProvider, fireAnalyticsEvent);
 
   // Initialize SSR data if available
@@ -40,7 +41,16 @@ var useMemoizedSyncedBlockNodeComponent = exports.useMemoizedSyncedBlockNodeComp
     }
   }, [getSSRData, syncBlockProvider]);
 
-  // Initial fetch sync block data (will use SSR data as initial cache if available)
+  // Process prefetched data next, if available
+  (0, _react.useEffect)(function () {
+    var prefetchedData;
+    if (getPrefetchedData) {
+      prefetchedData = getPrefetchedData();
+      syncBlockStoreManager.referenceManager.processPrefetchedData(prefetchedData);
+    }
+  }, [getPrefetchedData, syncBlockStoreManager.referenceManager]);
+
+  // Initial fetch sync block data (will use SSR data as initial cache, or the prefetched data if available)
   (0, _react.useEffect)(function () {
     syncBlockStoreManager.referenceManager.fetchSyncBlocksData(syncBlockNodes);
   }, [syncBlockNodes, syncBlockStoreManager.referenceManager]);

package/dist/es2019/ui/AKRendererWrapper.js

@@ -80,6 +80,7 @@ export const AKRendererWrapper = /*#__PURE__*/memo(({
     allowUgcScrubber,
     allowWrapCodeBlock,
     emojiResourceConfig,
+    eventHandlers,
     media,
     smartLinks,
     stickyHeaders
@@ -125,6 +126,7 @@ export const AKRendererWrapper = /*#__PURE__*/memo(({
     allowUgcScrubber: allowUgcScrubber,
     allowWrapCodeBlock: allowWrapCodeBlock,
     emojiResourceConfig: emojiResourceConfig,
+    eventHandlers: fg('platform_synced_block_patch_1') ? eventHandlers : undefined,
     media: media,
     smartLinks: smartLinks,
     stickyHeaders: stickyHeaders

package/dist/es2019/useSyncedBlockNodeComponent.js

@@ -17,7 +17,8 @@ export const useMemoizedSyncedBlockNodeComponent = ({
   syncBlockProvider,
   syncBlockRendererOptions,
   fireAnalyticsEvent,
-  getSSRData
+  getSSRData,
+  getPrefetchedData
 }) => {
   const syncBlockStoreManager = useMemoizedSyncBlockStoreManager(syncBlockProvider, fireAnalyticsEvent);
 
@@ -31,7 +32,16 @@ export const useMemoizedSyncedBlockNodeComponent = ({
     }
   }, [getSSRData, syncBlockProvider]);
 
-  // Initial fetch sync block data (will use SSR data as initial cache if available)
+  // Process prefetched data next, if available
+  useEffect(() => {
+    let prefetchedData;
+    if (getPrefetchedData) {
+      prefetchedData = getPrefetchedData();
+      syncBlockStoreManager.referenceManager.processPrefetchedData(prefetchedData);
+    }
+  }, [getPrefetchedData, syncBlockStoreManager.referenceManager]);
+
+  // Initial fetch sync block data (will use SSR data as initial cache, or the prefetched data if available)
   useEffect(() => {
     syncBlockStoreManager.referenceManager.fetchSyncBlocksData(syncBlockNodes);
   }, [syncBlockNodes, syncBlockStoreManager.referenceManager]);

package/dist/esm/ui/AKRendererWrapper.js

@@ -80,6 +80,7 @@ export var AKRendererWrapper = /*#__PURE__*/memo(function (_ref3) {
     allowUgcScrubber = _ref4.allowUgcScrubber,
     allowWrapCodeBlock = _ref4.allowWrapCodeBlock,
     emojiResourceConfig = _ref4.emojiResourceConfig,
+    eventHandlers = _ref4.eventHandlers,
     media = _ref4.media,
     smartLinks = _ref4.smartLinks,
     stickyHeaders = _ref4.stickyHeaders;
@@ -124,6 +125,7 @@ export var AKRendererWrapper = /*#__PURE__*/memo(function (_ref3) {
     allowUgcScrubber: allowUgcScrubber,
     allowWrapCodeBlock: allowWrapCodeBlock,
     emojiResourceConfig: emojiResourceConfig,
+    eventHandlers: fg('platform_synced_block_patch_1') ? eventHandlers : undefined,
     media: media,
     smartLinks: smartLinks,
     stickyHeaders: stickyHeaders

package/dist/esm/useSyncedBlockNodeComponent.js

@@ -19,7 +19,8 @@ export var useMemoizedSyncedBlockNodeComponent = function useMemoizedSyncedBlock
     syncBlockProvider = _ref.syncBlockProvider,
     syncBlockRendererOptions = _ref.syncBlockRendererOptions,
     fireAnalyticsEvent = _ref.fireAnalyticsEvent,
-    getSSRData = _ref.getSSRData;
+    getSSRData = _ref.getSSRData,
+    getPrefetchedData = _ref.getPrefetchedData;
   var syncBlockStoreManager = useMemoizedSyncBlockStoreManager(syncBlockProvider, fireAnalyticsEvent);
 
   // Initialize SSR data if available
@@ -32,7 +33,16 @@ export var useMemoizedSyncedBlockNodeComponent = function useMemoizedSyncedBlock
     }
   }, [getSSRData, syncBlockProvider]);
 
-  // Initial fetch sync block data (will use SSR data as initial cache if available)
+  // Process prefetched data next, if available
+  useEffect(function () {
+    var prefetchedData;
+    if (getPrefetchedData) {
+      prefetchedData = getPrefetchedData();
+      syncBlockStoreManager.referenceManager.processPrefetchedData(prefetchedData);
+    }
+  }, [getPrefetchedData, syncBlockStoreManager.referenceManager]);
+
+  // Initial fetch sync block data (will use SSR data as initial cache, or the prefetched data if available)
   useEffect(function () {
     syncBlockStoreManager.referenceManager.fetchSyncBlocksData(syncBlockNodes);
   }, [syncBlockNodes, syncBlockStoreManager.referenceManager]);

package/dist/types/types.d.ts

@@ -1,2 +1,2 @@
 import { type RendererProps } from '@atlaskit/renderer';
-export type SyncedBlockRendererOptions = Pick<RendererProps, 'appearance' | 'allowAltTextOnImages' | 'allowAnnotations' | 'allowColumnSorting' | 'allowCopyToClipboard' | 'allowCustomPanels' | 'allowHeadingAnchorLinks' | 'allowPlaceholderText' | 'allowRendererContainerStyles' | 'allowSelectAllTrap' | 'allowUgcScrubber' | 'allowWrapCodeBlock' | 'emojiResourceConfig' | 'media' | 'smartLinks' | 'stickyHeaders'>;
+export type SyncedBlockRendererOptions = Pick<RendererProps, 'appearance' | 'allowAltTextOnImages' | 'allowAnnotations' | 'allowColumnSorting' | 'allowCopyToClipboard' | 'allowCustomPanels' | 'allowHeadingAnchorLinks' | 'allowPlaceholderText' | 'allowRendererContainerStyles' | 'allowSelectAllTrap' | 'allowUgcScrubber' | 'allowWrapCodeBlock' | 'emojiResourceConfig' | 'eventHandlers' | 'media' | 'smartLinks' | 'stickyHeaders'>;

package/dist/types/useSyncedBlockNodeComponent.d.ts

@@ -1,16 +1,16 @@
 import React from 'react';
 import type { DocNode } from '@atlaskit/adf-schema';
 import { type AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import { type SyncBlockInstance, type SyncBlockNode } from '@atlaskit/editor-synced-block-provider';
-import type { SyncedBlockProvider } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockInstance, type SyncBlockNode, type SyncedBlockProvider, type SyncBlockPrefetchData } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockRendererOptions } from './types';
 import { type SyncedBlockNodeProps } from './ui/SyncedBlockNodeComponentRenderer';
 export type GetSyncedBlockNodeComponentProps = {
     fireAnalyticsEvent?: (payload: AnalyticsEventPayload) => void;
+    getPrefetchedData?: () => SyncBlockPrefetchData | undefined;
     getSSRData?: () => Record<string, SyncBlockInstance> | undefined;
     syncBlockNodes: SyncBlockNode[];
     syncBlockProvider: SyncedBlockProvider;
     syncBlockRendererOptions: SyncedBlockRendererOptions | undefined;
 };
 export declare const getSyncBlockNodesFromDoc: (doc: DocNode) => SyncBlockNode[];
-export declare const useMemoizedSyncedBlockNodeComponent: ({ syncBlockNodes, syncBlockProvider, syncBlockRendererOptions, fireAnalyticsEvent, getSSRData, }: GetSyncedBlockNodeComponentProps) => ((props: SyncedBlockNodeProps) => React.JSX.Element);
+export declare const useMemoizedSyncedBlockNodeComponent: ({ syncBlockNodes, syncBlockProvider, syncBlockRendererOptions, fireAnalyticsEvent, getSSRData, getPrefetchedData, }: GetSyncedBlockNodeComponentProps) => ((props: SyncedBlockNodeProps) => React.JSX.Element);

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

@@ -1,2 +1,2 @@
 import { type RendererProps } from '@atlaskit/renderer';
-export type SyncedBlockRendererOptions = Pick<RendererProps, 'appearance' | 'allowAltTextOnImages' | 'allowAnnotations' | 'allowColumnSorting' | 'allowCopyToClipboard' | 'allowCustomPanels' | 'allowHeadingAnchorLinks' | 'allowPlaceholderText' | 'allowRendererContainerStyles' | 'allowSelectAllTrap' | 'allowUgcScrubber' | 'allowWrapCodeBlock' | 'emojiResourceConfig' | 'media' | 'smartLinks' | 'stickyHeaders'>;
+export type SyncedBlockRendererOptions = Pick<RendererProps, 'appearance' | 'allowAltTextOnImages' | 'allowAnnotations' | 'allowColumnSorting' | 'allowCopyToClipboard' | 'allowCustomPanels' | 'allowHeadingAnchorLinks' | 'allowPlaceholderText' | 'allowRendererContainerStyles' | 'allowSelectAllTrap' | 'allowUgcScrubber' | 'allowWrapCodeBlock' | 'emojiResourceConfig' | 'eventHandlers' | 'media' | 'smartLinks' | 'stickyHeaders'>;

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

@@ -1,16 +1,16 @@
 import React from 'react';
 import type { DocNode } from '@atlaskit/adf-schema';
 import { type AnalyticsEventPayload } from '@atlaskit/editor-common/analytics';
-import { type SyncBlockInstance, type SyncBlockNode } from '@atlaskit/editor-synced-block-provider';
-import type { SyncedBlockProvider } from '@atlaskit/editor-synced-block-provider';
+import { type SyncBlockInstance, type SyncBlockNode, type SyncedBlockProvider, type SyncBlockPrefetchData } from '@atlaskit/editor-synced-block-provider';
 import type { SyncedBlockRendererOptions } from './types';
 import { type SyncedBlockNodeProps } from './ui/SyncedBlockNodeComponentRenderer';
 export type GetSyncedBlockNodeComponentProps = {
     fireAnalyticsEvent?: (payload: AnalyticsEventPayload) => void;
+    getPrefetchedData?: () => SyncBlockPrefetchData | undefined;
     getSSRData?: () => Record<string, SyncBlockInstance> | undefined;
     syncBlockNodes: SyncBlockNode[];
     syncBlockProvider: SyncedBlockProvider;
     syncBlockRendererOptions: SyncedBlockRendererOptions | undefined;
 };
 export declare const getSyncBlockNodesFromDoc: (doc: DocNode) => SyncBlockNode[];
-export declare const useMemoizedSyncedBlockNodeComponent: ({ syncBlockNodes, syncBlockProvider, syncBlockRendererOptions, fireAnalyticsEvent, getSSRData, }: GetSyncedBlockNodeComponentProps) => ((props: SyncedBlockNodeProps) => React.JSX.Element);
+export declare const useMemoizedSyncedBlockNodeComponent: ({ syncBlockNodes, syncBlockProvider, syncBlockRendererOptions, fireAnalyticsEvent, getSSRData, getPrefetchedData, }: GetSyncedBlockNodeComponentProps) => ((props: SyncedBlockNodeProps) => React.JSX.Element);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-synced-block-renderer",
-	"version": "5.6.7",
+	"version": "5.7.1",
 	"description": "SyncedBlockRenderer for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -31,7 +31,7 @@
 		"@atlaskit/button": "^23.9.0",
 		"@atlaskit/css": "^0.19.0",
 		"@atlaskit/editor-plugin-synced-block": "^5.3.0",
-		"@atlaskit/editor-synced-block-provider": "^3.26.0",
+		"@atlaskit/editor-synced-block-provider": "^3.27.0",
 		"@atlaskit/heading": "^5.3.0",
 		"@atlaskit/icon": "^30.0.0",
 		"@atlaskit/icon-lab": "^5.15.0",
@@ -48,7 +48,7 @@
 		"relay-runtime": "npm:atl-relay-runtime@0.0.0-main-39e79f66"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.11.0",
+		"@atlaskit/editor-common": "^111.12.0",
 		"react": "^18.2.0",
 		"react-intl-next": "npm:react-intl@^5.18.1"
 	},