@atlaskit/editor-synced-block-provider 3.11.0 → 3.12.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.12.0
+
+### Minor Changes
+
+- [`3d9abca1c1cd9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/3d9abca1c1cd9) -
+  The batch retrieve of the blocks must also send document ARI and also the local instance ID of the
+  reference blocks
+
 ## 3.11.0
 
 ### Minor Changes

package/dist/cjs/clients/block-service/blockService.js

@@ -137,11 +137,11 @@ var BlockError = exports.BlockError = /*#__PURE__*/function (_Error) {
 }( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
 var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/function () {
   var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(_ref2) {
-    var blockAri, queryParams, response;
+    var blockAri, documentAri, queryParams, response;
     return _regenerator.default.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
-          blockAri = _ref2.blockAri;
+          blockAri = _ref2.blockAri, documentAri = _ref2.documentAri;
           // Disable sending documentAri for now. We'll add it back if we find a way to update references that follows the save & refresh principle.
           // Slack discussion here: https://atlassian.slack.com/archives/C09DZT1TBNW/p1767836775552099?thread_ts=1767836754.024889&cid=C09DZT1TBNW
           // const queryParams = documentAri ? `?documentAri=${encodeURIComponent(documentAri)}` : '';

package/dist/cjs/providers/block-service/blockServiceAPI.js

@@ -346,7 +346,7 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
 
     /**
      * Batch fetches multiple synced blocks by their resource IDs.
-     * @param blockNodeIdentifiers - Array of block node identifiers, containing block instance (local) ID + resource IDs to fetch
+     * @param resourceIds - Array of resource IDs to fetch
      * @returns Array of SyncBlockInstance results
      */
   }, {

package/dist/es2019/clients/block-service/blockService.js

@@ -100,8 +100,8 @@ export class BlockError extends Error {
   }
 }
 export const getSyncedBlockContent = async ({
-  blockAri
-  // documentAri,
+  blockAri,
+  documentAri
 }) => {
   // Disable sending documentAri for now. We'll add it back if we find a way to update references that follows the save & refresh principle.
   // Slack discussion here: https://atlassian.slack.com/archives/C09DZT1TBNW/p1767836775552099?thread_ts=1767836754.024889&cid=C09DZT1TBNW

package/dist/es2019/providers/block-service/blockServiceAPI.js

@@ -256,7 +256,7 @@ class BlockServiceADFFetchProvider {
 
   /**
    * Batch fetches multiple synced blocks by their resource IDs.
-   * @param blockNodeIdentifiers - Array of block node identifiers, containing block instance (local) ID + resource IDs to fetch
+   * @param resourceIds - Array of resource IDs to fetch
    * @returns Array of SyncBlockInstance results
    */
   async batchFetchData(blockNodeIdentifiers) {

package/dist/esm/clients/block-service/blockService.js

@@ -130,11 +130,11 @@ export var BlockError = /*#__PURE__*/function (_Error) {
 }( /*#__PURE__*/_wrapNativeSuper(Error));
 export var getSyncedBlockContent = /*#__PURE__*/function () {
   var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref2) {
-    var blockAri, queryParams, response;
+    var blockAri, documentAri, queryParams, response;
     return _regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
-          blockAri = _ref2.blockAri;
+          blockAri = _ref2.blockAri, documentAri = _ref2.documentAri;
           // Disable sending documentAri for now. We'll add it back if we find a way to update references that follows the save & refresh principle.
           // Slack discussion here: https://atlassian.slack.com/archives/C09DZT1TBNW/p1767836775552099?thread_ts=1767836754.024889&cid=C09DZT1TBNW
           // const queryParams = documentAri ? `?documentAri=${encodeURIComponent(documentAri)}` : '';

package/dist/esm/providers/block-service/blockServiceAPI.js

@@ -340,7 +340,7 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
 
     /**
      * Batch fetches multiple synced blocks by their resource IDs.
-     * @param blockNodeIdentifiers - Array of block node identifiers, containing block instance (local) ID + resource IDs to fetch
+     * @param resourceIds - Array of resource IDs to fetch
      * @returns Array of SyncBlockInstance results
      */
   }, {

package/dist/types/clients/block-service/blockService.d.ts

@@ -92,14 +92,14 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
     documentAri: string;
     noContent?: boolean;
 };
-type BlockIdentifier = {
-    blockAri: string;
-    blockInstanceId: string;
-};
 export type BatchRetrieveSyncedBlocksRequest = {
     blockIdentifiers: BlockIdentifier[];
     documentAri: string;
 };
+type BlockIdentifier = {
+    blockAri: string;
+    blockInstanceId: string;
+};
 export type BatchRetrieveSyncedBlocksResponse = {
     error?: Array<ErrorResponse>;
     success?: Array<BlockContentResponse>;
@@ -116,7 +116,7 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
-export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const getSyncedBlockContent: ({ blockAri, documentAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
  *

package/dist/types/providers/block-service/blockServiceAPI.d.ts

@@ -40,7 +40,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     private extractResourceIdFromBlockAri;
     /**
      * Batch fetches multiple synced blocks by their resource IDs.
-     * @param blockNodeIdentifiers - Array of block node identifiers, containing block instance (local) ID + resource IDs to fetch
+     * @param resourceIds - Array of resource IDs to fetch
      * @returns Array of SyncBlockInstance results
      */
     batchFetchData(blockNodeIdentifiers: BlockNodeIdentifiers[]): Promise<SyncBlockInstance[]>;

package/dist/types/providers/types.d.ts

@@ -5,6 +5,10 @@ import type { MentionProvider } from '@atlaskit/mention/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData } from '../common/types';
+export type BlockNodeIdentifiers = {
+    blockInstanceId: string;
+    resourceId: string;
+};
 /**
  * The instance of a sync block, containing its data and metadata.
  * Mainly used for representing the state of a sync block after fetching from a data provider.
@@ -52,10 +56,6 @@ export type UpdateReferenceSyncBlockResult = {
     error?: string;
     success: boolean;
 };
-export type BlockNodeIdentifiers = {
-    blockInstanceId: string;
-    resourceId: string;
-};
 export interface ADFFetchProvider {
     batchFetchData: (blockNodeIdentifiers: BlockNodeIdentifiers[]) => Promise<SyncBlockInstance[]>;
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
@@ -88,8 +88,8 @@ export type SyncedBlockRendererDataProviders = {
 export type SyncBlockRendererProviderCreator = {
     createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider> | undefined) | undefined;
     createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider> | undefined) | undefined;
-    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
     createSSRMediaProvider?: ((options: MediaEmojiProviderOptions) => MediaProvider | undefined) | undefined;
+    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
 };
 export type SyncedBlockRendererProviderOptions = {
     parentDataProviders?: SyncedBlockRendererDataProviders;

package/dist/types-ts4.5/clients/block-service/blockService.d.ts

@@ -92,14 +92,14 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
     documentAri: string;
     noContent?: boolean;
 };
-type BlockIdentifier = {
-    blockAri: string;
-    blockInstanceId: string;
-};
 export type BatchRetrieveSyncedBlocksRequest = {
     blockIdentifiers: BlockIdentifier[];
     documentAri: string;
 };
+type BlockIdentifier = {
+    blockAri: string;
+    blockInstanceId: string;
+};
 export type BatchRetrieveSyncedBlocksResponse = {
     error?: Array<ErrorResponse>;
     success?: Array<BlockContentResponse>;
@@ -116,7 +116,7 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
-export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const getSyncedBlockContent: ({ blockAri, documentAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
  *

package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts

@@ -40,7 +40,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     private extractResourceIdFromBlockAri;
     /**
      * Batch fetches multiple synced blocks by their resource IDs.
-     * @param blockNodeIdentifiers - Array of block node identifiers, containing block instance (local) ID + resource IDs to fetch
+     * @param resourceIds - Array of resource IDs to fetch
      * @returns Array of SyncBlockInstance results
      */
     batchFetchData(blockNodeIdentifiers: BlockNodeIdentifiers[]): Promise<SyncBlockInstance[]>;

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

@@ -5,6 +5,10 @@ import type { MentionProvider } from '@atlaskit/mention/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData } from '../common/types';
+export type BlockNodeIdentifiers = {
+    blockInstanceId: string;
+    resourceId: string;
+};
 /**
  * The instance of a sync block, containing its data and metadata.
  * Mainly used for representing the state of a sync block after fetching from a data provider.
@@ -52,10 +56,6 @@ export type UpdateReferenceSyncBlockResult = {
     error?: string;
     success: boolean;
 };
-export type BlockNodeIdentifiers = {
-    blockInstanceId: string;
-    resourceId: string;
-};
 export interface ADFFetchProvider {
     batchFetchData: (blockNodeIdentifiers: BlockNodeIdentifiers[]) => Promise<SyncBlockInstance[]>;
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
@@ -88,8 +88,8 @@ export type SyncedBlockRendererDataProviders = {
 export type SyncBlockRendererProviderCreator = {
     createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider> | undefined) | undefined;
     createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider> | undefined) | undefined;
-    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
     createSSRMediaProvider?: ((options: MediaEmojiProviderOptions) => MediaProvider | undefined) | undefined;
+    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
 };
 export type SyncedBlockRendererProviderOptions = {
     parentDataProviders?: SyncedBlockRendererDataProviders;

package/package.json

@@ -24,7 +24,7 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-utils": "^19.26.0",
+		"@atlaskit/adf-utils": "^19.27.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "^7.2.0",
 		"@atlaskit/node-data-provider": "^8.0.0",
@@ -77,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.11.0",
+	"version": "3.12.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",