@atlaskit/editor-synced-block-provider 3.16.0 → 3.17.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.17.0
+
+### Minor Changes
+
+- [`251219994ffd0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/251219994ffd0) -
+  Retrieve NCS step version from the editor actions
+
+### Patch Changes
+
+- [`87775069f24dc`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/87775069f24dc) -
+  Update update sync block references endpoint to be keepalive
+- Updated dependencies
+
 ## 3.16.0
 
 ### Minor Changes

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

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.updateSyncedBlock = exports.updateReferenceSyncedBlockOnDocument = exports.isBlockContentResponse = exports.getSyncedBlockContent = exports.getReferenceSyncedBlocksByBlockAri = exports.getReferenceSyncedBlocks = exports.deleteSyncedBlock = exports.createSyncedBlock = exports.batchRetrieveSyncedBlocks = exports.BlockError = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
@@ -15,6 +16,8 @@ var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/w
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
 var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _retry = require("../../utils/retry");
+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) { (0, _defineProperty2.default)(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; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(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; })(); }
 var isBlockContentResponse = exports.isBlockContentResponse = function isBlockContentResponse(response) {
@@ -346,13 +349,15 @@ var updateReferenceSyncedBlockOnDocument = exports.updateReferenceSyncedBlockOnD
         case 0:
           documentAri = _ref10.documentAri, blocks = _ref10.blocks, _ref10$noContent = _ref10.noContent, noContent = _ref10$noContent === void 0 ? true : _ref10$noContent;
           _context7.next = 3;
-          return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/document/").concat(encodeURIComponent(documentAri), "/references?noContent=").concat(noContent), {
+          return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/document/").concat(encodeURIComponent(documentAri), "/references?noContent=").concat(noContent), _objectSpread({
             method: 'PUT',
             headers: COMMON_HEADERS,
             body: JSON.stringify({
               blocks: blocks
             })
-          });
+          }, (0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding') ? {
+            keepalive: true
+          } : {}));
         case 3:
           response = _context7.sent;
           if (response.ok) {

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

@@ -651,39 +651,52 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                 product: this.product,
                 resourceId: resourceId
               });
-              stepVersion = this.getVersion ? this.getVersion() : undefined;
-              _context5.prev = 5;
-              _context5.next = 8;
+              if (!this.getVersion) {
+                _context5.next = 10;
+                break;
+              }
+              _context5.next = 7;
+              return this.getVersion();
+            case 7:
+              _context5.t0 = _context5.sent;
+              _context5.next = 11;
+              break;
+            case 10:
+              _context5.t0 = undefined;
+            case 11:
+              stepVersion = _context5.t0;
+              _context5.prev = 12;
+              _context5.next = 15;
               return (0, _blockService.updateSyncedBlock)({
                 blockAri: blockAri,
                 content: JSON.stringify(data.content),
                 stepVersion: stepVersion
               });
-            case 8:
+            case 15:
               return _context5.abrupt("return", {
                 resourceId: resourceId
               });
-            case 11:
-              _context5.prev = 11;
-              _context5.t0 = _context5["catch"](5);
-              if (!(_context5.t0 instanceof _blockService.BlockError)) {
-                _context5.next = 15;
+            case 18:
+              _context5.prev = 18;
+              _context5.t1 = _context5["catch"](12);
+              if (!(_context5.t1 instanceof _blockService.BlockError)) {
+                _context5.next = 22;
                 break;
               }
               return _context5.abrupt("return", {
-                error: mapBlockError(_context5.t0),
+                error: mapBlockError(_context5.t1),
                 resourceId: resourceId
               });
-            case 15:
+            case 22:
               return _context5.abrupt("return", {
-                error: (0, _errorHandling.stringifyError)(_context5.t0),
+                error: (0, _errorHandling.stringifyError)(_context5.t1),
                 resourceId: resourceId
               });
-            case 16:
+            case 23:
             case "end":
               return _context5.stop();
           }
-        }, _callee5, this, [[5, 11]]);
+        }, _callee5, this, [[12, 18]]);
       }));
       function writeData(_x5) {
         return _writeData.apply(this, arguments);
@@ -714,10 +727,23 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                 product: this.product,
                 resourceId: resourceId
               });
-              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              if (!this.getVersion) {
+                _context6.next = 10;
+                break;
+              }
+              _context6.next = 7;
+              return this.getVersion();
+            case 7:
+              _context6.t0 = _context6.sent;
+              _context6.next = 11;
+              break;
+            case 10:
+              _context6.t0 = undefined;
+            case 11:
+              stepVersion = _context6.t0;
               status = (0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding') ? (_this$isParentUnpubli = this.isParentUnpublished) !== null && _this$isParentUnpubli !== void 0 && _this$isParentUnpubli.call(this) ? 'unpublished' : data.status || 'active' : undefined;
-              _context6.prev = 6;
-              _context6.next = 9;
+              _context6.prev = 13;
+              _context6.next = 16;
               return (0, _blockService.createSyncedBlock)({
                 blockAri: blockAri,
                 blockInstanceId: data.blockInstanceId,
@@ -727,31 +753,31 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                 stepVersion: stepVersion,
                 status: status
               });
-            case 9:
+            case 16:
               return _context6.abrupt("return", {
                 resourceId: resourceId
               });
-            case 12:
-              _context6.prev = 12;
-              _context6.t0 = _context6["catch"](6);
-              if (!(_context6.t0 instanceof _blockService.BlockError)) {
-                _context6.next = 16;
+            case 19:
+              _context6.prev = 19;
+              _context6.t1 = _context6["catch"](13);
+              if (!(_context6.t1 instanceof _blockService.BlockError)) {
+                _context6.next = 23;
                 break;
               }
               return _context6.abrupt("return", {
-                error: mapBlockError(_context6.t0),
+                error: mapBlockError(_context6.t1),
                 resourceId: resourceId
               });
-            case 16:
+            case 23:
               return _context6.abrupt("return", {
-                error: (0, _errorHandling.stringifyError)(_context6.t0),
+                error: (0, _errorHandling.stringifyError)(_context6.t1),
                 resourceId: resourceId
               });
-            case 17:
+            case 24:
             case "end":
               return _context6.stop();
           }
-        }, _callee6, this, [[6, 12]]);
+        }, _callee6, this, [[13, 19]]);
       }));
       function createData(_x6) {
         return _createData.apply(this, arguments);

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

@@ -219,7 +219,10 @@ export const updateReferenceSyncedBlockOnDocument = async ({
     headers: COMMON_HEADERS,
     body: JSON.stringify({
       blocks
-    })
+    }),
+    ...(fg('platform_synced_block_dogfooding') ? {
+      keepalive: true
+    } : {})
   });
   if (!response.ok) {
     throw new BlockError(response.status);

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

@@ -479,7 +479,7 @@ class BlockServiceADFWriteProvider {
       product: this.product,
       resourceId
     });
-    const stepVersion = this.getVersion ? this.getVersion() : undefined;
+    const stepVersion = this.getVersion ? await this.getVersion() : undefined;
     try {
       // Try update existing block's content
       await updateSyncedBlock({
@@ -519,7 +519,7 @@ class BlockServiceADFWriteProvider {
       product: this.product,
       resourceId
     });
-    const stepVersion = this.getVersion ? this.getVersion() : undefined;
+    const stepVersion = this.getVersion ? await this.getVersion() : undefined;
     const status = fg('platform_synced_block_dogfooding') ? (_this$isParentUnpubli = this.isParentUnpublished) !== null && _this$isParentUnpubli !== void 0 && _this$isParentUnpubli.call(this) ? 'unpublished' : data.status || 'active' : undefined;
     try {
       await createSyncedBlock({

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

@@ -1,3 +1,4 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _createClass from "@babel/runtime/helpers/createClass";
 import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
 import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
@@ -5,6 +6,8 @@ import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
 import _inherits from "@babel/runtime/helpers/inherits";
 import _wrapNativeSuper from "@babel/runtime/helpers/wrapNativeSuper";
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+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; }
 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 _regeneratorRuntime from "@babel/runtime/regenerator";
@@ -339,13 +342,15 @@ export var updateReferenceSyncedBlockOnDocument = /*#__PURE__*/function () {
         case 0:
           documentAri = _ref10.documentAri, blocks = _ref10.blocks, _ref10$noContent = _ref10.noContent, noContent = _ref10$noContent === void 0 ? true : _ref10$noContent;
           _context7.next = 3;
-          return fetchWithRetry("".concat(BLOCK_SERVICE_API_URL, "/block/document/").concat(encodeURIComponent(documentAri), "/references?noContent=").concat(noContent), {
+          return fetchWithRetry("".concat(BLOCK_SERVICE_API_URL, "/block/document/").concat(encodeURIComponent(documentAri), "/references?noContent=").concat(noContent), _objectSpread({
             method: 'PUT',
             headers: COMMON_HEADERS,
             body: JSON.stringify({
               blocks: blocks
             })
-          });
+          }, fg('platform_synced_block_dogfooding') ? {
+            keepalive: true
+          } : {}));
         case 3:
           response = _context7.sent;
           if (response.ok) {

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

@@ -645,39 +645,52 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                 product: this.product,
                 resourceId: resourceId
               });
-              stepVersion = this.getVersion ? this.getVersion() : undefined;
-              _context5.prev = 5;
-              _context5.next = 8;
+              if (!this.getVersion) {
+                _context5.next = 10;
+                break;
+              }
+              _context5.next = 7;
+              return this.getVersion();
+            case 7:
+              _context5.t0 = _context5.sent;
+              _context5.next = 11;
+              break;
+            case 10:
+              _context5.t0 = undefined;
+            case 11:
+              stepVersion = _context5.t0;
+              _context5.prev = 12;
+              _context5.next = 15;
               return updateSyncedBlock({
                 blockAri: blockAri,
                 content: JSON.stringify(data.content),
                 stepVersion: stepVersion
               });
-            case 8:
+            case 15:
               return _context5.abrupt("return", {
                 resourceId: resourceId
               });
-            case 11:
-              _context5.prev = 11;
-              _context5.t0 = _context5["catch"](5);
-              if (!(_context5.t0 instanceof BlockError)) {
-                _context5.next = 15;
+            case 18:
+              _context5.prev = 18;
+              _context5.t1 = _context5["catch"](12);
+              if (!(_context5.t1 instanceof BlockError)) {
+                _context5.next = 22;
                 break;
               }
               return _context5.abrupt("return", {
-                error: mapBlockError(_context5.t0),
+                error: mapBlockError(_context5.t1),
                 resourceId: resourceId
               });
-            case 15:
+            case 22:
               return _context5.abrupt("return", {
-                error: stringifyError(_context5.t0),
+                error: stringifyError(_context5.t1),
                 resourceId: resourceId
               });
-            case 16:
+            case 23:
             case "end":
               return _context5.stop();
           }
-        }, _callee5, this, [[5, 11]]);
+        }, _callee5, this, [[12, 18]]);
       }));
       function writeData(_x5) {
         return _writeData.apply(this, arguments);
@@ -708,10 +721,23 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                 product: this.product,
                 resourceId: resourceId
               });
-              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              if (!this.getVersion) {
+                _context6.next = 10;
+                break;
+              }
+              _context6.next = 7;
+              return this.getVersion();
+            case 7:
+              _context6.t0 = _context6.sent;
+              _context6.next = 11;
+              break;
+            case 10:
+              _context6.t0 = undefined;
+            case 11:
+              stepVersion = _context6.t0;
               status = fg('platform_synced_block_dogfooding') ? (_this$isParentUnpubli = this.isParentUnpublished) !== null && _this$isParentUnpubli !== void 0 && _this$isParentUnpubli.call(this) ? 'unpublished' : data.status || 'active' : undefined;
-              _context6.prev = 6;
-              _context6.next = 9;
+              _context6.prev = 13;
+              _context6.next = 16;
               return createSyncedBlock({
                 blockAri: blockAri,
                 blockInstanceId: data.blockInstanceId,
@@ -721,31 +747,31 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
                 stepVersion: stepVersion,
                 status: status
               });
-            case 9:
+            case 16:
               return _context6.abrupt("return", {
                 resourceId: resourceId
               });
-            case 12:
-              _context6.prev = 12;
-              _context6.t0 = _context6["catch"](6);
-              if (!(_context6.t0 instanceof BlockError)) {
-                _context6.next = 16;
+            case 19:
+              _context6.prev = 19;
+              _context6.t1 = _context6["catch"](13);
+              if (!(_context6.t1 instanceof BlockError)) {
+                _context6.next = 23;
                 break;
               }
               return _context6.abrupt("return", {
-                error: mapBlockError(_context6.t0),
+                error: mapBlockError(_context6.t1),
                 resourceId: resourceId
               });
-            case 16:
+            case 23:
               return _context6.abrupt("return", {
-                error: stringifyError(_context6.t0),
+                error: stringifyError(_context6.t1),
                 resourceId: resourceId
               });
-            case 17:
+            case 24:
             case "end":
               return _context6.stop();
           }
-        }, _callee6, this, [[6, 12]]);
+        }, _callee6, this, [[13, 19]]);
       }));
       function createData(_x6) {
         return _createData.apply(this, arguments);

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

@@ -55,7 +55,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 }
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;
-    getVersion?: () => number | undefined;
+    getVersion?: () => Promise<number | undefined>;
     isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;
@@ -81,7 +81,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
 }
 interface BlockServiceAPIProvidersProps {
     cloudId: string;
-    getVersion?: () => number | undefined;
+    getVersion?: () => Promise<number | undefined>;
     isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;

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

@@ -55,7 +55,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 }
 interface BlockServiceADFWriteProviderProps {
     cloudId: string;
-    getVersion?: () => number | undefined;
+    getVersion?: () => Promise<number | undefined>;
     isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;
@@ -81,7 +81,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
 }
 interface BlockServiceAPIProvidersProps {
     cloudId: string;
-    getVersion?: () => number | undefined;
+    getVersion?: () => Promise<number | undefined>;
     isParentUnpublished?: () => boolean;
     parentAri: string | undefined;
     parentId?: string;

package/package.json

@@ -78,7 +78,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.16.0",
+	"version": "3.17.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",