@atlaskit/editor-synced-block-provider 3.2.0 → 3.2.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-synced-block-provider
 
+## 3.2.2
+
+### Patch Changes
+
+- [`d1a28b3f74e5e`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d1a28b3f74e5e) -
+  EDITOR-3594 Add creator Synced Block helpers for Jira Renderer
+
+## 3.2.1
+
+### Patch Changes
+
+- [`08984e84a58de`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/08984e84a58de) -
+  EDITOR-3594 Improve ARIs handling to ensure correctness
+
 ## 3.2.0
 
 ### Minor Changes

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

@@ -8,32 +8,29 @@ exports.getLocalIdFromBlockResourceId = exports.generateBlockAriFromReference =
 
 /**
  * Generates the block ARI from the source page ARI and the source block's resource ID.
- * @param sourceAri - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param cloudId - the cloudId of the block. E.G the cloudId of the confluence page, or the cloudId of the Jira instance
+ * @param parentId - the parentId of the block. E.G the pageId for a confluence page, or the issueId for a Jira work item
  * @param resourceId - the resource ID of the block node. A randomly generated UUID
+ * @param product - the product of the block. E.G 'confluence-page', 'jira-work-item'
  * @returns the block ARI. E.G ari:cloud:blocks:<cloudId>:synced-block/<product>/<pageId>/<resourceId>
  */
-var generateBlockAri = exports.generateBlockAri = function generateBlockAri(sourceAri, resourceId, product) {
-  var match = sourceAri.match(/ari:cloud:confluence:([^:]+):(page|blogpost)\/(\d+)/);
-  if (!(match !== null && match !== void 0 && match[1])) {
-    throw new Error("Invalid source ARI: ".concat(sourceAri));
-  }
-  var cloudId = match[1];
-  var pageId = match[3];
-  return "ari:cloud:blocks:".concat(cloudId, ":synced-block/").concat(product, "/").concat(pageId, "/").concat(resourceId);
+var generateBlockAri = exports.generateBlockAri = function generateBlockAri(_ref) {
+  var cloudId = _ref.cloudId,
+    parentId = _ref.parentId,
+    product = _ref.product,
+    resourceId = _ref.resourceId;
+  return "ari:cloud:blocks:".concat(cloudId, ":synced-block/").concat(product, "/").concat(parentId, "/").concat(resourceId);
 };
 
 /**
  * Generates the block ARI from the reference synced block ARI and the resource ID
- * @param sourceAri - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param cloudId - the cloudId of the block. E.G the cloudId of the confluence page, or the cloudId of the Jira instance
  * @param resourceId - the resource ID of the reference synced block. E.G confluence-page/pageId/sourceResourceId
  * @returns the block ARI. E.G ari:cloud:blocks:<cloudId>:synced-block/<product>/<pageId>/<resourceId>
  */
-var generateBlockAriFromReference = exports.generateBlockAriFromReference = function generateBlockAriFromReference(sourceAri, resourceId) {
-  var match = sourceAri.match(/ari:cloud:confluence:([^:]+):(page|blogpost)\/(\d+)/);
-  if (!(match !== null && match !== void 0 && match[1])) {
-    throw new Error("Invalid source ARI: ".concat(sourceAri));
-  }
-  var cloudId = match[1];
+var generateBlockAriFromReference = exports.generateBlockAriFromReference = function generateBlockAriFromReference(_ref2) {
+  var cloudId = _ref2.cloudId,
+    resourceId = _ref2.resourceId;
   return "ari:cloud:blocks:".concat(cloudId, ":synced-block/").concat(resourceId);
 };
 

package/dist/cjs/clients/confluence/ari.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.resourceIdFromConfluencePageSourceIdAndLocalId = exports.getPageIdAndTypeFromConfluencePageAri = exports.getPageAriFromContentPropertyResourceId = exports.getLocalIdFromContentPropertyResourceId = exports.getConfluencePageAri = void 0;
+exports.getPageIdAndTypeFromConfluencePageAri = exports.getConfluencePageAri = void 0;
 /* eslint-disable require-unicode-regexp  */
 
 /**
@@ -17,8 +17,10 @@ exports.resourceIdFromConfluencePageSourceIdAndLocalId = exports.getPageIdAndTyp
  * @param pageType - the type of the page
  * @returns the Confluence page ARI
  */
-var getConfluencePageAri = exports.getConfluencePageAri = function getConfluencePageAri(pageId, cloudId) {
-  var pageType = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'page';
+var getConfluencePageAri = exports.getConfluencePageAri = function getConfluencePageAri(_ref) {
+  var pageId = _ref.pageId,
+    cloudId = _ref.cloudId,
+    pageType = _ref.pageType;
   return "ari:cloud:confluence:".concat(cloudId, ":").concat(pageType, "/").concat(pageId);
 };
 
@@ -27,7 +29,8 @@ var getConfluencePageAri = exports.getConfluencePageAri = function getConfluence
  * @param ari - the Confluence page ARI
  * @returns the page ID and type
  */
-var getPageIdAndTypeFromConfluencePageAri = exports.getPageIdAndTypeFromConfluencePageAri = function getPageIdAndTypeFromConfluencePageAri(ari) {
+var getPageIdAndTypeFromConfluencePageAri = exports.getPageIdAndTypeFromConfluencePageAri = function getPageIdAndTypeFromConfluencePageAri(_ref2) {
+  var ari = _ref2.ari;
   var match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/(\d+)/);
   if (match !== null && match !== void 0 && match[2]) {
     return {
@@ -36,40 +39,4 @@ var getPageIdAndTypeFromConfluencePageAri = exports.getPageIdAndTypeFromConfluen
     };
   }
   throw new Error("Invalid page ARI: ".concat(ari));
-};
-
-/**
- * Extracts the local ID from the Confluence page content property resource ID
- * @param resourceId - the Confluence page content property resource ID
- * @returns the local ID
- */
-var getLocalIdFromContentPropertyResourceId = exports.getLocalIdFromContentPropertyResourceId = function getLocalIdFromContentPropertyResourceId(resourceId) {
-  var match = resourceId.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/\d+\/([a-zA-Z0-9-]+)/);
-  if (match !== null && match !== void 0 && match[2]) {
-    return match[2];
-  }
-  throw new Error("Invalid resourceId: ".concat(resourceId));
-};
-
-/**
- * Extracts the Confluence page ARI from the Confluence content property resource ID
- * @param resourceId - the Confluence content property resource ID
- * @returns the Confluence page ARI
- */
-var getPageAriFromContentPropertyResourceId = exports.getPageAriFromContentPropertyResourceId = function getPageAriFromContentPropertyResourceId(resourceId) {
-  var match = resourceId.match(/(ari:cloud:confluence:[^:]+:(page|blogpost)\/\d+)\/([a-zA-Z0-9-]+)$/);
-  if (match !== null && match !== void 0 && match[1]) {
-    return match[1];
-  }
-  throw new Error("Invalid resourceId: ".concat(resourceId));
-};
-
-/**
- * Generates the Confluence page content property resource ID from the source ID and local ID
- * @param sourceId - the source ID
- * @param localId - the local ID
- * @returns the Confluence page content property resource ID
- */
-var resourceIdFromConfluencePageSourceIdAndLocalId = exports.resourceIdFromConfluencePageSourceIdAndLocalId = function resourceIdFromConfluencePageSourceIdAndLocalId(sourceId, localId) {
-  return "".concat(sourceId, "/").concat(localId);
 };

package/dist/cjs/clients/confluence/sourceInfo.js

@@ -78,7 +78,9 @@ var fetchConfluencePageInfo = exports.fetchConfluencePageInfo = /*#__PURE__*/fun
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
           _context2.prev = 0;
-          _getPageIdAndTypeFrom = (0, _ari.getPageIdAndTypeFromConfluencePageAri)(pageAri), pageType = _getPageIdAndTypeFrom.type;
+          _getPageIdAndTypeFrom = (0, _ari.getPageIdAndTypeFromConfluencePageAri)({
+            ari: pageAri
+          }), pageType = _getPageIdAndTypeFrom.type;
           _context2.next = 4;
           return getConfluenceSourceInfo(pageAri);
         case 4:

package/dist/cjs/clients/jira/ari.js

@@ -12,7 +12,9 @@ exports.getJiraWorkItemIdFromAri = exports.getJiraWorkItemAri = void 0;
  * @param cloudId - the cloud ID
  * @returns the Jira work item ARI
  */
-var getJiraWorkItemAri = exports.getJiraWorkItemAri = function getJiraWorkItemAri(workItemId, cloudId) {
+var getJiraWorkItemAri = exports.getJiraWorkItemAri = function getJiraWorkItemAri(_ref) {
+  var cloudId = _ref.cloudId,
+    workItemId = _ref.workItemId;
   return "ari:cloud:jira:".concat(cloudId, ":issue/").concat(workItemId);
 };
 
@@ -21,7 +23,8 @@ var getJiraWorkItemAri = exports.getJiraWorkItemAri = function getJiraWorkItemAr
  * @param ari - the Jira work item ARI
  * @returns the Jira work item ID
  */
-var getJiraWorkItemIdFromAri = exports.getJiraWorkItemIdFromAri = function getJiraWorkItemIdFromAri(ari) {
+var getJiraWorkItemIdFromAri = exports.getJiraWorkItemIdFromAri = function getJiraWorkItemIdFromAri(_ref2) {
+  var ari = _ref2.ari;
   var match = ari.match(/ari:cloud:jira:([^:]+):issue\/(\d+)/);
   if (match !== null && match !== void 0 && match[2]) {
     return match[2];

package/dist/cjs/index.js

@@ -39,10 +39,28 @@ Object.defineProperty(exports, "convertSyncBlockPMNodeToSyncBlockData", {
     return _utils.convertSyncBlockPMNodeToSyncBlockData;
   }
 });
-Object.defineProperty(exports, "createContentAPIProvidersWithDefaultKey", {
+Object.defineProperty(exports, "createAndInitializeSyncBlockStoreManager", {
   enumerable: true,
   get: function get() {
-    return _confluenceContentAPI.createContentAPIProvidersWithDefaultKey;
+    return _syncBlockStoreManager.createAndInitializeSyncBlockStoreManager;
+  }
+});
+Object.defineProperty(exports, "createAndInitializeSyncedBlockProvider", {
+  enumerable: true,
+  get: function get() {
+    return _syncBlockProvider.createAndInitializeSyncedBlockProvider;
+  }
+});
+Object.defineProperty(exports, "createBlockServiceAPIProviders", {
+  enumerable: true,
+  get: function get() {
+    return _blockServiceAPI.createBlockServiceAPIProviders;
+  }
+});
+Object.defineProperty(exports, "createBlockServiceFetchOnlyAPIProvider", {
+  enumerable: true,
+  get: function get() {
+    return _blockServiceAPI.createBlockServiceFetchOnlyAPIProvider;
   }
 });
 Object.defineProperty(exports, "createSyncBlockNode", {
@@ -111,18 +129,6 @@ Object.defineProperty(exports, "getLocalIdFromBlockResourceId", {
     return _ari.getLocalIdFromBlockResourceId;
   }
 });
-Object.defineProperty(exports, "getLocalIdFromContentPropertyResourceId", {
-  enumerable: true,
-  get: function get() {
-    return _ari2.getLocalIdFromContentPropertyResourceId;
-  }
-});
-Object.defineProperty(exports, "getPageAriFromContentPropertyResourceId", {
-  enumerable: true,
-  get: function get() {
-    return _ari2.getPageAriFromContentPropertyResourceId;
-  }
-});
 Object.defineProperty(exports, "getPageIdAndTypeFromConfluencePageAri", {
   enumerable: true,
   get: function get() {
@@ -141,12 +147,6 @@ Object.defineProperty(exports, "resolveSyncBlockInstance", {
     return _resolveSyncBlockInstance.resolveSyncBlockInstance;
   }
 });
-Object.defineProperty(exports, "resourceIdFromConfluencePageSourceIdAndLocalId", {
-  enumerable: true,
-  get: function get() {
-    return _ari2.resourceIdFromConfluencePageSourceIdAndLocalId;
-  }
-});
 Object.defineProperty(exports, "useFetchSyncBlockData", {
   enumerable: true,
   get: function get() {
@@ -171,10 +171,10 @@ Object.defineProperty(exports, "useMemoizedBlockServiceAPIProviders", {
     return _blockServiceAPI.useMemoizedBlockServiceAPIProviders;
   }
 });
-Object.defineProperty(exports, "useMemoizedContentAPIProviders", {
+Object.defineProperty(exports, "useMemoizedBlockServiceFetchOnlyAPIProvider", {
   enumerable: true,
   get: function get() {
-    return _confluenceContentAPI.useMemoizedContentAPIProviders;
+    return _blockServiceAPI.useMemoizedBlockServiceFetchOnlyAPIProvider;
   }
 });
 Object.defineProperty(exports, "useMemoizedSyncBlockStoreManager", {
@@ -198,7 +198,6 @@ var _ari = require("./clients/block-service/ari");
 var _ari2 = require("./clients/confluence/ari");
 var _ari3 = require("./clients/jira/ari");
 var _blockServiceAPI = require("./providers/block-service/blockServiceAPI");
-var _confluenceContentAPI = require("./providers/confluence/confluenceContentAPI");
 var _sourceInfo = require("./clients/confluence/sourceInfo");
 var _syncBlockProvider = require("./providers/syncBlockProvider");
 var _syncBlockStoreManager = require("./store-manager/syncBlockStoreManager");

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

@@ -4,7 +4,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.useMemoizedBlockServiceAPIProviders = exports.fetchReferences = void 0;
+exports.useMemoizedBlockServiceFetchOnlyAPIProvider = exports.useMemoizedBlockServiceAPIProviders = exports.fetchReferences = exports.createBlockServiceFetchOnlyAPIProvider = exports.createBlockServiceAPIProviders = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
@@ -112,14 +112,14 @@ var fetchReferences = exports.fetchReferences = /*#__PURE__*/function () {
     return _ref.apply(this, arguments);
   };
 }();
-
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */
 var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
-  function BlockServiceADFFetchProvider(sourceAri) {
+  function BlockServiceADFFetchProvider(_ref3) {
+    var cloudId = _ref3.cloudId;
     (0, _classCallCheck2.default)(this, BlockServiceADFFetchProvider);
-    this.sourceAri = sourceAri;
+    this.cloudId = cloudId;
   }
 
   // resourceId of the reference synced block.
@@ -132,7 +132,10 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
         return _regenerator.default.wrap(function _callee2$(_context2) {
           while (1) switch (_context2.prev = _context2.next) {
             case 0:
-              blockAri = (0, _ari.generateBlockAriFromReference)(this.sourceAri, resourceId);
+              blockAri = (0, _ari.generateBlockAriFromReference)({
+                cloudId: this.cloudId,
+                resourceId: resourceId
+              });
               _context2.prev = 1;
               _context2.next = 4;
               return (0, _blockService.getSyncedBlockContent)({
@@ -196,11 +199,17 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
-  function BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion) {
+  function BlockServiceADFWriteProvider(_ref4) {
+    var cloudId = _ref4.cloudId,
+      parentAri = _ref4.parentAri,
+      parentId = _ref4.parentId,
+      product = _ref4.product,
+      getVersion = _ref4.getVersion;
     (0, _classCallCheck2.default)(this, BlockServiceADFWriteProvider);
-    this.sourceAri = sourceAri;
+    this.cloudId = cloudId;
+    this.parentAri = parentAri;
+    this.parentId = parentId;
     this.product = product;
-    this.sourceDocumentId = sourceDocumentId;
     this.getVersion = getVersion;
   }
 
@@ -214,7 +223,12 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               resourceId = data.resourceId;
-              blockAri = (0, _ari.generateBlockAri)(this.sourceAri, resourceId, this.product);
+              blockAri = (0, _ari.generateBlockAri)({
+                cloudId: this.cloudId,
+                parentId: this.parentId,
+                product: this.product,
+                resourceId: resourceId
+              });
               stepVersion = this.getVersion ? this.getVersion() : undefined;
               _context3.prev = 3;
               _context3.next = 6;
@@ -263,14 +277,19 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
               resourceId = data.resourceId;
-              blockAri = (0, _ari.generateBlockAri)(this.sourceAri, resourceId, this.product);
+              blockAri = (0, _ari.generateBlockAri)({
+                cloudId: this.cloudId,
+                parentId: this.parentId,
+                product: this.product,
+                resourceId: resourceId
+              });
               stepVersion = this.getVersion ? this.getVersion() : undefined;
               _context4.prev = 3;
               _context4.next = 6;
               return (0, _blockService.createSyncedBlock)({
                 blockAri: blockAri,
                 blockInstanceId: data.blockInstanceId,
-                sourceAri: this.sourceAri,
+                sourceAri: this.parentAri,
                 product: this.product,
                 content: JSON.stringify(data.content),
                 stepVersion: stepVersion
@@ -314,7 +333,12 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
         return _regenerator.default.wrap(function _callee5$(_context5) {
           while (1) switch (_context5.prev = _context5.next) {
             case 0:
-              blockAri = (0, _ari.generateBlockAri)(this.sourceAri, resourceId, this.product);
+              blockAri = (0, _ari.generateBlockAri)({
+                cloudId: this.cloudId,
+                parentId: this.parentId,
+                product: this.product,
+                resourceId: resourceId
+              });
               _context5.prev = 1;
               _context5.next = 4;
               return (0, _blockService.deleteSyncedBlock)({
@@ -367,7 +391,7 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
   }, {
     key: "generateResourceIdForReference",
     value: function generateResourceIdForReference(sourceId) {
-      return "".concat(this.product, "/").concat(this.sourceDocumentId, "/").concat(sourceId);
+      return "".concat(this.product, "/").concat(this.parentId, "/").concat(sourceId);
     }
   }, {
     key: "generateResourceId",
@@ -385,10 +409,13 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
               _context6.prev = 0;
               _context6.next = 3;
               return (0, _blockService.updateReferenceSyncedBlockOnDocument)({
-                documentAri: this.sourceAri,
+                documentAri: this.parentAri,
                 blocks: blocks.map(function (block) {
                   return {
-                    blockAri: (0, _ari.generateBlockAriFromReference)(_this.sourceAri, block.resourceId),
+                    blockAri: (0, _ari.generateBlockAriFromReference)({
+                      cloudId: _this.cloudId,
+                      resourceId: block.resourceId
+                    }),
                     blockInstanceId: block.localId
                   };
                 }),
@@ -427,19 +454,55 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     }()
   }]);
 }();
-/**
- * Factory function to create both providers with shared configuration
- */
-var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
-  var fetchProvider = new BlockServiceADFFetchProvider(sourceAri);
-  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion);
+var createBlockServiceAPIProviders = exports.createBlockServiceAPIProviders = function createBlockServiceAPIProviders(_ref5) {
+  var cloudId = _ref5.cloudId,
+    parentAri = _ref5.parentAri,
+    parentId = _ref5.parentId,
+    product = _ref5.product,
+    getVersion = _ref5.getVersion;
+  return {
+    fetchProvider: new BlockServiceADFFetchProvider({
+      cloudId: cloudId
+    }),
+    writeProvider: new BlockServiceADFWriteProvider({
+      cloudId: cloudId,
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product,
+      getVersion: getVersion
+    })
+  };
+};
+var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(_ref6) {
+  var cloudId = _ref6.cloudId,
+    parentAri = _ref6.parentAri,
+    parentId = _ref6.parentId,
+    product = _ref6.product,
+    getVersion = _ref6.getVersion;
+  return (0, _react.useMemo)(function () {
+    return createBlockServiceAPIProviders({
+      cloudId: cloudId,
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product,
+      getVersion: getVersion
+    });
+  }, [cloudId, parentAri, parentId, product, getVersion]);
+};
+var createBlockServiceFetchOnlyAPIProvider = exports.createBlockServiceFetchOnlyAPIProvider = function createBlockServiceFetchOnlyAPIProvider(_ref7) {
+  var cloudId = _ref7.cloudId;
   return {
-    fetchProvider: fetchProvider,
-    writeProvider: writeProvider
+    fetchProvider: new BlockServiceADFFetchProvider({
+      cloudId: cloudId
+    }),
+    writeProvider: undefined
   };
 };
-var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
+var useMemoizedBlockServiceFetchOnlyAPIProvider = exports.useMemoizedBlockServiceFetchOnlyAPIProvider = function useMemoizedBlockServiceFetchOnlyAPIProvider(_ref8) {
+  var cloudId = _ref8.cloudId;
   return (0, _react.useMemo)(function () {
-    return createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion);
-  }, [sourceAri, product, sourceDocumentId, getVersion]);
+    return createBlockServiceFetchOnlyAPIProvider({
+      cloudId: cloudId
+    });
+  }, [cloudId]);
 };