@atlaskit/editor-synced-block-provider 4.0.0 → 4.1.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @atlaskit/editor-synced-block-provider
 
+## 4.1.0
+
+### Minor Changes
+
+- [`beb2f030213b1`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/beb2f030213b1) -
+  EDITOR-5735 Make SSR bulk request configurable
+
+### Patch Changes
+
+- Updated dependencies
+
+## 4.0.1
+
+### Patch Changes
+
+- [`b8082ae893289`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b8082ae893289) -
+  Account for new deletionReason: source-block-unpublished
+- Updated dependencies
+
 ## 4.0.0
 
 ### Patch Changes

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

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.updateSyncedBlocks = exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.batchRetrieveSyncedBlocks = exports.BlockError = void 0;
+exports.updateSyncedBlocks = exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.batchRetrieveSyncedBlocks = exports.BlockTimeoutError = exports.BlockError = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -225,6 +225,17 @@ var BlockError = exports.BlockError = /*#__PURE__*/function (_Error) {
   (0, _inherits2.default)(BlockError, _Error);
   return (0, _createClass2.default)(BlockError);
 }( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
+var BlockTimeoutError = exports.BlockTimeoutError = /*#__PURE__*/function (_Error2) {
+  function BlockTimeoutError() {
+    var _this2;
+    (0, _classCallCheck2.default)(this, BlockTimeoutError);
+    _this2 = _callSuper(this, BlockTimeoutError, ['Block request timed out']);
+    _this2.name = 'BlockTimeoutError';
+    return _this2;
+  }
+  (0, _inherits2.default)(BlockTimeoutError, _Error2);
+  return (0, _createClass2.default)(BlockTimeoutError);
+}( /*#__PURE__*/(0, _wrapNativeSuper2.default)(Error));
 var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/function () {
   var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee2(_ref2) {
     var _result$data;
@@ -293,12 +304,12 @@ var getSyncedBlockContent = exports.getSyncedBlockContent = /*#__PURE__*/functio
  */
 var batchRetrieveSyncedBlocks = exports.batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
   var _ref5 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(_ref4) {
-    var _result$data2;
-    var blockIdentifiers, blockAris, bodyData, url, response, result, graphqlResponse;
+    var _config$timeoutMs, _result$data2;
+    var blockIdentifiers, config, blockAris, bodyData, url, fetchPromise, timeoutMs, response, result, graphqlResponse;
     return _regenerator.default.wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
-          blockIdentifiers = _ref4.blockIdentifiers;
+          blockIdentifiers = _ref4.blockIdentifiers, config = _ref4.config;
           blockAris = blockIdentifiers.map(function (blockIdentifier) {
             return blockIdentifier.blockAri;
           });
@@ -306,45 +317,52 @@ var batchRetrieveSyncedBlocks = exports.batchRetrieveSyncedBlocks = /*#__PURE__*
             query: buildBatchRetrieveBlocksQuery(blockAris),
             operationName: BATCH_RETRIEVE_BLOCKS_OPERATION_NAME
           };
-          url = "".concat(GRAPHQL_ENDPOINT, "?operation=editorSyncedBlockBatchRetrieveBlocks");
-          _context3.next = 6;
-          return (0, _retry.fetchWithRetry)(url, {
+          url = "".concat(GRAPHQL_ENDPOINT, "?operation=editorSyncedBlockBatchRetrieveBlocks"); // undefined or 0 or negative means no timeout,
+          // We don't enforce a minimum timeout for simplicity
+          fetchPromise = (0, _retry.fetchWithRetry)(url, {
             method: 'POST',
             headers: COMMON_HEADERS,
             body: JSON.stringify(bodyData)
           });
-        case 6:
+          timeoutMs = (_config$timeoutMs = config === null || config === void 0 ? void 0 : config.timeoutMs) !== null && _config$timeoutMs !== void 0 ? _config$timeoutMs : 0;
+          _context3.next = 8;
+          return timeoutMs > 0 ? Promise.race([fetchPromise, new Promise(function (_, reject) {
+            return setTimeout(function () {
+              return reject(new BlockTimeoutError());
+            }, timeoutMs);
+          })]) : fetchPromise;
+        case 8:
           response = _context3.sent;
           if (response.ok) {
-            _context3.next = 9;
+            _context3.next = 11;
             break;
           }
           throw new BlockError(response.status);
-        case 9:
-          _context3.next = 11;
-          return response.json();
         case 11:
+          _context3.next = 13;
+          return response.json();
+        case 13:
           result = _context3.sent;
           if (!(result.errors && result.errors.length > 0)) {
-            _context3.next = 14;
+            _context3.next = 16;
             break;
           }
           throw new Error(result.errors.map(function (e) {
             return e.message;
           }).join(', '));
-        case 14:
+        case 16:
           if ((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_batchRetrieveBlocks) {
-            _context3.next = 16;
+            _context3.next = 18;
             break;
           }
           throw new Error('No data returned from GraphQL query');
-        case 16:
+        case 18:
           graphqlResponse = result.data.blockService_batchRetrieveBlocks;
           return _context3.abrupt("return", {
             success: graphqlResponse.success,
             error: graphqlResponse.error
           });
-        case 18:
+        case 20:
         case "end":
           return _context3.stop();
       }

package/dist/cjs/common/types.js

@@ -17,5 +17,7 @@ var SyncBlockError = exports.SyncBlockError = /*#__PURE__*/function (SyncBlockEr
   // content is not a valid JSON
   SyncBlockError["Offline"] = "offline";
   SyncBlockError["Unpublished"] = "unpublished";
+  // request was aborted, typically due to client timeout
+  SyncBlockError["Aborted"] = "aborted";
   return SyncBlockError;
 }({});

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

@@ -12,6 +12,7 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _react = require("react");
+var _expValEquals = require("@atlaskit/tmp-editor-statsig/exp-val-equals");
 var _ari = require("../../clients/block-service/ari");
 var _blockService = require("../../clients/block-service/blockService");
 var _blockSubscription = require("../../clients/block-service/blockSubscription");
@@ -392,6 +393,20 @@ var _batchFetchData = exports.batchFetchData = /*#__PURE__*/function () {
         case 61:
           _context2.prev = 61;
           _context2.t2 = _context2["catch"](5);
+          if (!(_context2.t2 instanceof _blockService.BlockTimeoutError && (0, _expValEquals.expValEquals)('platform_editor_sync_block_ssr_config', 'isEnabled', true))) {
+            _context2.next = 65;
+            break;
+          }
+          return _context2.abrupt("return", blockNodeIdentifiers.map(function (blockNodeIdentifier) {
+            return {
+              error: {
+                type: _types.SyncBlockError.Aborted,
+                reason: _context2.t2.message
+              },
+              resourceId: blockNodeIdentifier.resourceId
+            };
+          }));
+        case 65:
           return _context2.abrupt("return", blockNodeIdentifiers.map(function (blockNodeIdentifier) {
             return {
               error: {
@@ -401,7 +416,7 @@ var _batchFetchData = exports.batchFetchData = /*#__PURE__*/function () {
               resourceId: blockNodeIdentifier.resourceId
             };
           }));
-        case 64:
+        case 66:
         case "end":
           return _context2.stop();
       }

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

@@ -297,6 +297,12 @@ export class BlockError extends Error {
     this.status = status;
   }
 }
+export class BlockTimeoutError extends Error {
+  constructor() {
+    super('Block request timed out');
+    this.name = 'BlockTimeoutError';
+  }
+}
 export const getSyncedBlockContent = async ({
   blockAri
 }) => {
@@ -334,20 +340,27 @@ export const getSyncedBlockContent = async ({
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
  */
 export const batchRetrieveSyncedBlocks = async ({
-  blockIdentifiers
+  blockIdentifiers,
+  config
 }) => {
-  var _result$data2;
+  var _config$timeoutMs, _result$data2;
   const blockAris = blockIdentifiers.map(blockIdentifier => blockIdentifier.blockAri);
   const bodyData = {
     query: buildBatchRetrieveBlocksQuery(blockAris),
     operationName: BATCH_RETRIEVE_BLOCKS_OPERATION_NAME
   };
   const url = `${GRAPHQL_ENDPOINT}?operation=editorSyncedBlockBatchRetrieveBlocks`;
-  const response = await fetchWithRetry(url, {
+
+  // undefined or 0 or negative means no timeout,
+  // We don't enforce a minimum timeout for simplicity
+
+  const fetchPromise = fetchWithRetry(url, {
     method: 'POST',
     headers: COMMON_HEADERS,
     body: JSON.stringify(bodyData)
   });
+  const timeoutMs = (_config$timeoutMs = config === null || config === void 0 ? void 0 : config.timeoutMs) !== null && _config$timeoutMs !== void 0 ? _config$timeoutMs : 0;
+  const response = await (timeoutMs > 0 ? Promise.race([fetchPromise, new Promise((_, reject) => setTimeout(() => reject(new BlockTimeoutError()), timeoutMs))]) : fetchPromise);
   if (!response.ok) {
     throw new BlockError(response.status);
   }

package/dist/es2019/common/types.js

@@ -11,5 +11,7 @@ export let SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   // content is not a valid JSON
   SyncBlockError["Offline"] = "offline";
   SyncBlockError["Unpublished"] = "unpublished";
+  // request was aborted, typically due to client timeout
+  SyncBlockError["Aborted"] = "aborted";
   return SyncBlockError;
 }({});

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

@@ -1,7 +1,8 @@
 /* eslint-disable require-unicode-regexp  */
 import { useMemo } from 'react';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
-import { batchRetrieveSyncedBlocks, BlockError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
+import { batchRetrieveSyncedBlocks, BlockError, BlockTimeoutError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
 import { subscribeToBlockUpdates as subscribeToBlockUpdatesWS } from '../../clients/block-service/blockSubscription';
 import { SyncBlockError } from '../../common/types';
 import { stringifyError } from '../../utils/errorHandling';
@@ -287,6 +288,16 @@ export const batchFetchData = async (cloudId, parentAri, blockNodeIdentifiers, c
     }
     return results;
   } catch (error) {
+    if (error instanceof BlockTimeoutError && expValEquals('platform_editor_sync_block_ssr_config', 'isEnabled', true)) {
+      return blockNodeIdentifiers.map(blockNodeIdentifier => ({
+        error: {
+          type: SyncBlockError.Aborted,
+          reason: error.message
+        },
+        resourceId: blockNodeIdentifier.resourceId
+      }));
+    }
+
     // If batch request fails, return error for all resourceIds
     return blockNodeIdentifiers.map(blockNodeIdentifier => ({
       error: {

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

@@ -218,6 +218,17 @@ export var BlockError = /*#__PURE__*/function (_Error) {
   _inherits(BlockError, _Error);
   return _createClass(BlockError);
 }( /*#__PURE__*/_wrapNativeSuper(Error));
+export var BlockTimeoutError = /*#__PURE__*/function (_Error2) {
+  function BlockTimeoutError() {
+    var _this2;
+    _classCallCheck(this, BlockTimeoutError);
+    _this2 = _callSuper(this, BlockTimeoutError, ['Block request timed out']);
+    _this2.name = 'BlockTimeoutError';
+    return _this2;
+  }
+  _inherits(BlockTimeoutError, _Error2);
+  return _createClass(BlockTimeoutError);
+}( /*#__PURE__*/_wrapNativeSuper(Error));
 export var getSyncedBlockContent = /*#__PURE__*/function () {
   var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(_ref2) {
     var _result$data;
@@ -286,12 +297,12 @@ export var getSyncedBlockContent = /*#__PURE__*/function () {
  */
 export var batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
   var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref4) {
-    var _result$data2;
-    var blockIdentifiers, blockAris, bodyData, url, response, result, graphqlResponse;
+    var _config$timeoutMs, _result$data2;
+    var blockIdentifiers, config, blockAris, bodyData, url, fetchPromise, timeoutMs, response, result, graphqlResponse;
     return _regeneratorRuntime.wrap(function _callee3$(_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
-          blockIdentifiers = _ref4.blockIdentifiers;
+          blockIdentifiers = _ref4.blockIdentifiers, config = _ref4.config;
           blockAris = blockIdentifiers.map(function (blockIdentifier) {
             return blockIdentifier.blockAri;
           });
@@ -299,45 +310,52 @@ export var batchRetrieveSyncedBlocks = /*#__PURE__*/function () {
             query: buildBatchRetrieveBlocksQuery(blockAris),
             operationName: BATCH_RETRIEVE_BLOCKS_OPERATION_NAME
           };
-          url = "".concat(GRAPHQL_ENDPOINT, "?operation=editorSyncedBlockBatchRetrieveBlocks");
-          _context3.next = 6;
-          return fetchWithRetry(url, {
+          url = "".concat(GRAPHQL_ENDPOINT, "?operation=editorSyncedBlockBatchRetrieveBlocks"); // undefined or 0 or negative means no timeout,
+          // We don't enforce a minimum timeout for simplicity
+          fetchPromise = fetchWithRetry(url, {
             method: 'POST',
             headers: COMMON_HEADERS,
             body: JSON.stringify(bodyData)
           });
-        case 6:
+          timeoutMs = (_config$timeoutMs = config === null || config === void 0 ? void 0 : config.timeoutMs) !== null && _config$timeoutMs !== void 0 ? _config$timeoutMs : 0;
+          _context3.next = 8;
+          return timeoutMs > 0 ? Promise.race([fetchPromise, new Promise(function (_, reject) {
+            return setTimeout(function () {
+              return reject(new BlockTimeoutError());
+            }, timeoutMs);
+          })]) : fetchPromise;
+        case 8:
           response = _context3.sent;
           if (response.ok) {
-            _context3.next = 9;
+            _context3.next = 11;
             break;
           }
           throw new BlockError(response.status);
-        case 9:
-          _context3.next = 11;
-          return response.json();
         case 11:
+          _context3.next = 13;
+          return response.json();
+        case 13:
           result = _context3.sent;
           if (!(result.errors && result.errors.length > 0)) {
-            _context3.next = 14;
+            _context3.next = 16;
             break;
           }
           throw new Error(result.errors.map(function (e) {
             return e.message;
           }).join(', '));
-        case 14:
+        case 16:
           if ((_result$data2 = result.data) !== null && _result$data2 !== void 0 && _result$data2.blockService_batchRetrieveBlocks) {
-            _context3.next = 16;
+            _context3.next = 18;
             break;
           }
           throw new Error('No data returned from GraphQL query');
-        case 16:
+        case 18:
           graphqlResponse = result.data.blockService_batchRetrieveBlocks;
           return _context3.abrupt("return", {
             success: graphqlResponse.success,
             error: graphqlResponse.error
           });
-        case 18:
+        case 20:
         case "end":
           return _context3.stop();
       }

package/dist/esm/common/types.js

@@ -11,5 +11,7 @@ export var SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   // content is not a valid JSON
   SyncBlockError["Offline"] = "offline";
   SyncBlockError["Unpublished"] = "unpublished";
+  // request was aborted, typically due to client timeout
+  SyncBlockError["Aborted"] = "aborted";
   return SyncBlockError;
 }({});

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

@@ -11,8 +11,9 @@ function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length)
 import _regeneratorRuntime from "@babel/runtime/regenerator";
 /* eslint-disable require-unicode-regexp  */
 import { useMemo } from 'react';
+import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
 import { generateBlockAri as _generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
-import { batchRetrieveSyncedBlocks, BlockError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
+import { batchRetrieveSyncedBlocks, BlockError, BlockTimeoutError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
 import { subscribeToBlockUpdates as subscribeToBlockUpdatesWS } from '../../clients/block-service/blockSubscription';
 import { SyncBlockError } from '../../common/types';
 import { stringifyError } from '../../utils/errorHandling';
@@ -386,6 +387,20 @@ var _batchFetchData = /*#__PURE__*/function () {
         case 61:
           _context2.prev = 61;
           _context2.t2 = _context2["catch"](5);
+          if (!(_context2.t2 instanceof BlockTimeoutError && expValEquals('platform_editor_sync_block_ssr_config', 'isEnabled', true))) {
+            _context2.next = 65;
+            break;
+          }
+          return _context2.abrupt("return", blockNodeIdentifiers.map(function (blockNodeIdentifier) {
+            return {
+              error: {
+                type: SyncBlockError.Aborted,
+                reason: _context2.t2.message
+              },
+              resourceId: blockNodeIdentifier.resourceId
+            };
+          }));
+        case 65:
           return _context2.abrupt("return", blockNodeIdentifiers.map(function (blockNodeIdentifier) {
             return {
               error: {
@@ -395,7 +410,7 @@ var _batchFetchData = /*#__PURE__*/function () {
               resourceId: blockNodeIdentifier.resourceId
             };
           }));
-        case 64:
+        case 66:
         case "end":
           return _context2.stop();
       }

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

@@ -134,6 +134,9 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
+export declare class BlockTimeoutError extends Error {
+    constructor();
+}
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
@@ -144,7 +147,7 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
  * @param config - Optional batch fetch configuration (e.g. timeout)
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
  */
-export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
+export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, config, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
 export declare const deleteSyncedBlock: ({ blockAri, deleteReason, }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, status, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;

package/dist/types/common/types.d.ts

@@ -25,7 +25,8 @@ export declare enum SyncBlockError {
     ServerError = "server_error",
     InvalidContent = "invalid_content",// content is not a valid JSON
     Offline = "offline",
-    Unpublished = "unpublished"
+    Unpublished = "unpublished",
+    Aborted = "aborted"
 }
 export interface SyncBlockData {
     blockInstanceId: BlockInstanceId;
@@ -71,7 +72,7 @@ export type ReferencesSourceInfo = {
     error?: SyncBlockError;
     references?: Array<SyncBlockSourceInfo | undefined>;
 };
-export type DeletionReason = 'source-block-deleted' | 'source-block-unsynced';
+export type DeletionReason = 'source-block-deleted' | 'source-block-unsynced' | 'source-block-unpublished';
 export type DeletionReasonResponse = DeletionReason | 'source-document-deleted';
 export type SyncBlockPrefetchData = {
     prefetchPromise: Promise<SyncBlockInstance[] | undefined>;

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

@@ -88,7 +88,7 @@ export interface ADFWriteProvider {
     /**
      * Delete source block.
      * @param resourceId the resourceId of the block to be deleted
-     * @param deleteReason the reason for the deletion, e.g. 'source-block-unsynced', 'source-block-deleted'
+     * @param deleteReason the reason for the deletion, e.g. 'source-block-unsynced', 'source-block-deleted', 'source-block-unpublished'
      * @returns Object representing the result of the deletion. {resourceId: string, success: boolean, error?: string}.
      * User should not be blocked by not_found error when deleting, so successful result should be returned for 404 error
      */

package/dist/types/store-manager/referenceSyncBlockStoreManager.d.ts

@@ -1,6 +1,6 @@
 import { type RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Experience } from '@atlaskit/editor-common/experiences';
-import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { ProviderFactory, type MediaProvider } from '@atlaskit/editor-common/provider-factory';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockNode, type SyncBlockPrefetchData } from '../common/types';
 import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProviderInterface, TitleSubscriptionCallback, SyncBlockSourceInfo } from '../providers/types';
@@ -140,7 +140,7 @@ export declare class ReferenceSyncBlockStoreManager {
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
     getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     getSSRProviders(resourceId: ResourceId): {
-        media: import("@atlaskit/editor-common/provider-factory").MediaProvider;
+        media: MediaProvider;
     } | null;
     private retrieveDynamicProviders;
     /**

package/dist/types/store-manager/syncBlockProviderFactoryManager.d.ts

@@ -1,5 +1,5 @@
 import { type RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { ProviderFactory, type MediaProvider } from '@atlaskit/editor-common/provider-factory';
 import type { ResourceId } from '../common/types';
 import type { SyncBlockInstance, SyncBlockDataProviderInterface } from '../providers/types';
 export interface SyncBlockProviderFactoryManagerDeps {
@@ -17,7 +17,7 @@ export declare class SyncBlockProviderFactoryManager {
     constructor(deps: SyncBlockProviderFactoryManagerDeps);
     getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     getSSRProviders(resourceId: ResourceId): {
-        media: import("@atlaskit/editor-common/provider-factory").MediaProvider;
+        media: MediaProvider;
     } | null;
     deleteFactory(resourceId: ResourceId): void;
     destroy(): void;

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

@@ -134,6 +134,9 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
+export declare class BlockTimeoutError extends Error {
+    constructor();
+}
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
@@ -144,7 +147,7 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
  * @param config - Optional batch fetch configuration (e.g. timeout)
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
  */
-export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
+export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, config, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
 export declare const deleteSyncedBlock: ({ blockAri, deleteReason, }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, status, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;

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

@@ -25,7 +25,8 @@ export declare enum SyncBlockError {
     ServerError = "server_error",
     InvalidContent = "invalid_content",// content is not a valid JSON
     Offline = "offline",
-    Unpublished = "unpublished"
+    Unpublished = "unpublished",
+    Aborted = "aborted"
 }
 export interface SyncBlockData {
     blockInstanceId: BlockInstanceId;
@@ -71,7 +72,7 @@ export type ReferencesSourceInfo = {
     error?: SyncBlockError;
     references?: Array<SyncBlockSourceInfo | undefined>;
 };
-export type DeletionReason = 'source-block-deleted' | 'source-block-unsynced';
+export type DeletionReason = 'source-block-deleted' | 'source-block-unsynced' | 'source-block-unpublished';
 export type DeletionReasonResponse = DeletionReason | 'source-document-deleted';
 export type SyncBlockPrefetchData = {
     prefetchPromise: Promise<SyncBlockInstance[] | undefined>;

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

@@ -88,7 +88,7 @@ export interface ADFWriteProvider {
     /**
      * Delete source block.
      * @param resourceId the resourceId of the block to be deleted
-     * @param deleteReason the reason for the deletion, e.g. 'source-block-unsynced', 'source-block-deleted'
+     * @param deleteReason the reason for the deletion, e.g. 'source-block-unsynced', 'source-block-deleted', 'source-block-unpublished'
      * @returns Object representing the result of the deletion. {resourceId: string, success: boolean, error?: string}.
      * User should not be blocked by not_found error when deleting, so successful result should be returned for 404 error
      */

package/dist/types-ts4.5/store-manager/referenceSyncBlockStoreManager.d.ts

@@ -1,6 +1,6 @@
 import { type RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import type { Experience } from '@atlaskit/editor-common/experiences';
-import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { ProviderFactory, type MediaProvider } from '@atlaskit/editor-common/provider-factory';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockNode, type SyncBlockPrefetchData } from '../common/types';
 import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProviderInterface, TitleSubscriptionCallback, SyncBlockSourceInfo } from '../providers/types';
@@ -140,7 +140,7 @@ export declare class ReferenceSyncBlockStoreManager {
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
     getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     getSSRProviders(resourceId: ResourceId): {
-        media: import("@atlaskit/editor-common/provider-factory").MediaProvider;
+        media: MediaProvider;
     } | null;
     private retrieveDynamicProviders;
     /**

package/dist/types-ts4.5/store-manager/syncBlockProviderFactoryManager.d.ts

@@ -1,5 +1,5 @@
 import { type RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
+import { ProviderFactory, type MediaProvider } from '@atlaskit/editor-common/provider-factory';
 import type { ResourceId } from '../common/types';
 import type { SyncBlockInstance, SyncBlockDataProviderInterface } from '../providers/types';
 export interface SyncBlockProviderFactoryManagerDeps {
@@ -17,7 +17,7 @@ export declare class SyncBlockProviderFactoryManager {
     constructor(deps: SyncBlockProviderFactoryManagerDeps);
     getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     getSSRProviders(resourceId: ResourceId): {
-        media: import("@atlaskit/editor-common/provider-factory").MediaProvider;
+        media: MediaProvider;
     } | null;
     deleteFactory(resourceId: ResourceId): void;
     destroy(): void;

package/package.json

@@ -29,6 +29,7 @@
 		"@atlaskit/editor-prosemirror": "^7.3.0",
 		"@atlaskit/node-data-provider": "^9.0.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/tmp-editor-statsig": "^40.3.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0",
 		"graphql-ws": "^5.14.2",
@@ -37,7 +38,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^112.0.0",
+		"@atlaskit/editor-common": "^112.5.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -80,7 +81,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "4.0.0",
+	"version": "4.1.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",