@atlaskit/editor-synced-block-provider 3.3.0 → 3.4.1

package/dist/esm/providers/syncBlockProvider.js

@@ -1,5 +1,5 @@
-import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _toConsumableArray from "@babel/runtime/helpers/toConsumableArray";
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
@@ -10,6 +10,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 import { useMemo } from 'react';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari';
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
 import { SyncBlockError } from '../common/types';
@@ -66,7 +67,7 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
     }
 
     /**
-     * Fetch the data from the fetch provider
+     * Fetch the data from the fetch provider using batch API
      *
      * @param nodes
      *
@@ -74,30 +75,66 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
      */
   }, {
     key: "fetchNodesData",
-    value: function fetchNodesData(nodes) {
-      var _this2 = this;
-      var resourceIdSet = new Set(nodes.map(function (node) {
-        return node.attrs.resourceId;
+    value: (function () {
+      var _fetchNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(nodes) {
+        var _this2 = this;
+        var resourceIdSet, resourceIds;
+        return _regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              resourceIdSet = new Set(nodes.map(function (node) {
+                return node.attrs.resourceId;
+              }));
+              resourceIds = _toConsumableArray(resourceIdSet);
+              if (!fg('platform_synced_block_dogfooding')) {
+                _context.next = 14;
+                break;
+              }
+              _context.prev = 3;
+              _context.next = 6;
+              return this.fetchProvider.batchFetchData(resourceIds);
+            case 6:
+              return _context.abrupt("return", _context.sent);
+            case 9:
+              _context.prev = 9;
+              _context.t0 = _context["catch"](3);
+              return _context.abrupt("return", resourceIds.map(function (resourceId) {
+                return {
+                  error: SyncBlockError.Errored,
+                  resourceId: resourceId
+                };
+              }));
+            case 12:
+              _context.next = 15;
+              break;
+            case 14:
+              return _context.abrupt("return", Promise.allSettled(resourceIds.map(function (resourceId) {
+                return _this2.fetchProvider.fetchData(resourceId).then(function (data) {
+                  return data;
+                }, function () {
+                  return {
+                    error: SyncBlockError.Errored,
+                    resourceId: resourceId
+                  };
+                });
+              })).then(function (results) {
+                return results.filter(function (result) {
+                  return result.status === 'fulfilled';
+                }).map(function (result) {
+                  return result.value;
+                });
+              }));
+            case 15:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this, [[3, 9]]);
       }));
-      var resourceIds = _toConsumableArray(resourceIdSet);
-      return Promise.allSettled(resourceIds.map(function (resourceId) {
-        return _this2.fetchProvider.fetchData(resourceId).then(function (data) {
-          return data;
-        }, function () {
-          return {
-            error: SyncBlockError.Errored,
-            resourceId: resourceId
-          };
-        });
-      })).then(function (results) {
-        return results.filter(function (result) {
-          return result.status === 'fulfilled';
-        }).map(function (result) {
-          return result.value;
-        });
-      });
-    }
-
+      function fetchNodesData(_x) {
+        return _fetchNodesData.apply(this, arguments);
+      }
+      return fetchNodesData;
+    }()
     /**
      * Write the data to the write provider
      *
@@ -107,22 +144,23 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
      * @returns Array of {resourceId?: string, error?: string}.
      * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
+    )
   }, {
     key: "writeNodesData",
     value: (function () {
-      var _writeNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(nodes, data) {
+      var _writeNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(nodes, data) {
         var _this3 = this;
         var results;
-        return _regeneratorRuntime.wrap(function _callee$(_context) {
-          while (1) switch (_context.prev = _context.next) {
+        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
+          while (1) switch (_context2.prev = _context2.next) {
             case 0:
               if (this.writeProvider) {
-                _context.next = 2;
+                _context2.next = 2;
                 break;
               }
-              return _context.abrupt("return", Promise.reject(new Error('Write provider not set')));
+              return _context2.abrupt("return", Promise.reject(new Error('Write provider not set')));
             case 2:
-              _context.next = 4;
+              _context2.next = 4;
               return Promise.allSettled(nodes.map(function (_node, index) {
                 var _this3$writeProvider;
                 if (!_this3.writeProvider) {
@@ -134,8 +172,8 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
                 return (_this3$writeProvider = _this3.writeProvider) === null || _this3$writeProvider === void 0 ? void 0 : _this3$writeProvider.writeData(data[index]);
               }));
             case 4:
-              results = _context.sent;
-              return _context.abrupt("return", results.map(function (result) {
+              results = _context2.sent;
+              return _context2.abrupt("return", results.map(function (result) {
                 if (result.status === 'fulfilled') {
                   return result.value;
                 } else {
@@ -146,11 +184,11 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
               }));
             case 6:
             case "end":
-              return _context.stop();
+              return _context2.stop();
           }
-        }, _callee, this);
+        }, _callee2, this);
       }));
-      function writeNodesData(_x, _x2) {
+      function writeNodesData(_x2, _x3) {
         return _writeNodesData.apply(this, arguments);
       }
       return writeNodesData;
@@ -180,19 +218,19 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
   }, {
     key: "deleteNodesData",
     value: (function () {
-      var _deleteNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(resourceIds) {
+      var _deleteNodesData = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(resourceIds) {
         var _this4 = this;
         var results;
-        return _regeneratorRuntime.wrap(function _callee2$(_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
+        return _regeneratorRuntime.wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
             case 0:
               if (this.writeProvider) {
-                _context2.next = 2;
+                _context3.next = 2;
                 break;
               }
-              return _context2.abrupt("return", Promise.reject(new Error('Write provider not set')));
+              return _context3.abrupt("return", Promise.reject(new Error('Write provider not set')));
             case 2:
-              _context2.next = 4;
+              _context3.next = 4;
               return Promise.allSettled(resourceIds.map(function (resourceId) {
                 if (!_this4.writeProvider) {
                   return Promise.reject('Write provider not set');
@@ -200,8 +238,8 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
                 return _this4.writeProvider.deleteData(resourceId);
               }));
             case 4:
-              results = _context2.sent;
-              return _context2.abrupt("return", results.map(function (result, index) {
+              results = _context3.sent;
+              return _context3.abrupt("return", results.map(function (result, index) {
                 if (result.status === 'fulfilled') {
                   return result.value;
                 } else {
@@ -214,11 +252,11 @@ export var SyncBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
               }));
             case 6:
             case "end":
-              return _context2.stop();
+              return _context3.stop();
           }
-        }, _callee2, this);
+        }, _callee3, this);
       }));
-      function deleteNodesData(_x3) {
+      function deleteNodesData(_x4) {
         return _deleteNodesData.apply(this, arguments);
       }
       return deleteNodesData;

package/dist/esm/store-manager/sourceSyncBlockStoreManager.js

@@ -6,6 +6,7 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { logException } from '@atlaskit/editor-common/monitoring';
+import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
 import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload } from '../utils/errorHandling';
 import { convertSyncBlockPMNodeToSyncBlockData } from '../utils/utils';
@@ -32,6 +33,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function setFireAnalyticsEvent(fireAnalyticsEvent) {
       this.fireAnalyticsEvent = fireAnalyticsEvent;
     }
+  }, {
+    key: "setCreateExperience",
+    value: function setCreateExperience(createExperience) {
+      this.createExperience = createExperience;
+    }
   }, {
     key: "isSourceBlock",
     value: function isSourceBlock(node) {
@@ -264,28 +270,49 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           if (resourceId) {
             _this4.commitPendingCreation(true);
           } else {
-            var _this4$fireAnalyticsE;
             _this4.commitPendingCreation(false);
-            (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block'));
+            if (fg('platform_synced_block_dogfooding')) {
+              var _this4$createExperien;
+              (_this4$createExperien = _this4.createExperience) === null || _this4$createExperien === void 0 || _this4$createExperien.failure({
+                reason: result.error || 'Failed to create bodied sync block'
+              });
+            } else {
+              var _this4$fireAnalyticsE;
+              (_this4$fireAnalyticsE = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE === void 0 || _this4$fireAnalyticsE.call(_this4, createErrorPayload(result.error || 'Failed to create bodied sync block'));
+            }
           }
         }).catch(function (error) {
-          var _this4$fireAnalyticsE2;
           _this4.commitPendingCreation(false);
           logException(error, {
             location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
           });
-          (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, createErrorPayload(error.message));
+          if (fg('platform_synced_block_dogfooding')) {
+            var _this4$createExperien2;
+            (_this4$createExperien2 = _this4.createExperience) === null || _this4$createExperien2 === void 0 || _this4$createExperien2.failure({
+              reason: error.message
+            });
+          } else {
+            var _this4$fireAnalyticsE2;
+            (_this4$fireAnalyticsE2 = _this4.fireAnalyticsEvent) === null || _this4$fireAnalyticsE2 === void 0 || _this4$fireAnalyticsE2.call(_this4, createErrorPayload(error.message));
+          }
         });
         this.registerPendingCreation(resourceId);
       } catch (error) {
-        var _this$fireAnalyticsEv3;
         if (this.hasPendingCreation()) {
           this.commitPendingCreation(false);
         }
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, createErrorPayload(error.message));
+        if (fg('platform_synced_block_dogfooding')) {
+          var _this$createExperienc;
+          (_this$createExperienc = this.createExperience) === null || _this$createExperienc === void 0 || _this$createExperienc.failure({
+            reason: error.message
+          });
+        } else {
+          var _this$fireAnalyticsEv3;
+          (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, createErrorPayload(error.message));
+        }
       }
     }
   }, {

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

@@ -90,11 +90,27 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
     documentAri: string;
     noContent?: boolean;
 };
+export type BatchRetrieveSyncedBlocksRequest = {
+    blockAris: string[];
+};
+export type BatchRetrieveSyncedBlocksResponse = {
+    error?: Array<BlockContentErrorResponse>;
+    success?: Array<BlockContentResponse>;
+};
 export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+/**
+ * Batch retrieves multiple synced blocks by their ARIs.
+ *
+ * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ *
+ * @param blockAris - Array of block ARIs to retrieve
+ * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
+ */
+export declare const batchRetrieveSyncedBlocks: ({ blockAris, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
 export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;

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

@@ -11,6 +11,17 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     private cloudId;
     constructor({ cloudId }: BlockServiceADFFetchProviderProps);
     fetchData(resourceId: string): Promise<SyncBlockInstance>;
+    /**
+     * Extracts the resourceId from a block ARI.
+     * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
+     */
+    private extractResourceIdFromBlockAri;
+    /**
+     * Batch fetches multiple synced blocks by their resource IDs.
+     * @param resourceIds - Array of resource IDs to fetch
+     * @returns Array of SyncBlockInstance results
+     */
+    batchFetchData(resourceIds: string[]): Promise<SyncBlockInstance[]>;
 }
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;

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

@@ -33,7 +33,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      */
     nodeDataKey(node: SyncBlockNode): string;
     /**
-     * Fetch the data from the fetch provider
+     * Fetch the data from the fetch provider using batch API
      *
      * @param nodes
      *

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

@@ -44,6 +44,7 @@ export type UpdateReferenceSyncBlockResult = {
     success: boolean;
 };
 export interface ADFFetchProvider {
+    batchFetchData: (resourceIds: ResourceId[]) => Promise<SyncBlockInstance[]>;
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
 export interface ADFWriteProvider {

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

@@ -1,4 +1,5 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
+import type { Experience } from '@atlaskit/editor-common/experiences';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
@@ -15,8 +16,10 @@ export declare class SourceSyncBlockStoreManager {
     private deletionRetryInfo?;
     private pendingResourceId?;
     private creationCallback?;
+    createExperience: Experience | undefined;
     constructor(dataProvider?: SyncBlockDataProvider);
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
+    setCreateExperience(createExperience: Experience): void;
     isSourceBlock(node: PMNode): boolean;
     /**
      * Add/update a sync block node to/from the local cache

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

@@ -90,11 +90,27 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
     documentAri: string;
     noContent?: boolean;
 };
+export type BatchRetrieveSyncedBlocksRequest = {
+    blockAris: string[];
+};
+export type BatchRetrieveSyncedBlocksResponse = {
+    error?: Array<BlockContentErrorResponse>;
+    success?: Array<BlockContentResponse>;
+};
 export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+/**
+ * Batch retrieves multiple synced blocks by their ARIs.
+ *
+ * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
+ *
+ * @param blockAris - Array of block ARIs to retrieve
+ * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
+ */
+export declare const batchRetrieveSyncedBlocks: ({ blockAris, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
 export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;

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

@@ -11,6 +11,17 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     private cloudId;
     constructor({ cloudId }: BlockServiceADFFetchProviderProps);
     fetchData(resourceId: string): Promise<SyncBlockInstance>;
+    /**
+     * Extracts the resourceId from a block ARI.
+     * Block ARI format: ari:cloud:blocks:<cloudId>:synced-block/<resourceId>
+     */
+    private extractResourceIdFromBlockAri;
+    /**
+     * Batch fetches multiple synced blocks by their resource IDs.
+     * @param resourceIds - Array of resource IDs to fetch
+     * @returns Array of SyncBlockInstance results
+     */
+    batchFetchData(resourceIds: string[]): Promise<SyncBlockInstance[]>;
 }
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;

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

@@ -33,7 +33,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      */
     nodeDataKey(node: SyncBlockNode): string;
     /**
-     * Fetch the data from the fetch provider
+     * Fetch the data from the fetch provider using batch API
      *
      * @param nodes
      *

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

@@ -44,6 +44,7 @@ export type UpdateReferenceSyncBlockResult = {
     success: boolean;
 };
 export interface ADFFetchProvider {
+    batchFetchData: (resourceIds: ResourceId[]) => Promise<SyncBlockInstance[]>;
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
 export interface ADFWriteProvider {

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

@@ -1,4 +1,5 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
+import type { Experience } from '@atlaskit/editor-common/experiences';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
@@ -15,8 +16,10 @@ export declare class SourceSyncBlockStoreManager {
     private deletionRetryInfo?;
     private pendingResourceId?;
     private creationCallback?;
+    createExperience: Experience | undefined;
     constructor(dataProvider?: SyncBlockDataProvider);
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
+    setCreateExperience(createExperience: Experience): void;
     isSourceBlock(node: PMNode): boolean;
     /**
      * Add/update a sync block node to/from the local cache

package/package.json

@@ -28,12 +28,13 @@
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "^7.2.0",
 		"@atlaskit/node-data-provider": "^8.0.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.6",
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^111.0.0",
+		"@atlaskit/editor-common": "^111.2.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -76,11 +77,16 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.3.0",
+	"version": "3.4.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
+	},
+	"platform-feature-flags": {
+		"platform_synced_block_dogfooding": {
+			"type": "boolean"
+		}
 	}
 }