@atlaskit/editor-synced-block-provider 2.15.6 → 2.16.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.16.1
+
+### Patch Changes
+
+- [`5f9c5b4ae25c7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/5f9c5b4ae25c7) -
+  EDITOR-3594 Add Jira ARI utility functions to synced block provider
+
+## 2.16.0
+
+### Minor Changes
+
+- [`1e626a0fb59a7`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1e626a0fb59a7) -
+  Can pass in get NCS step version function
+
 ## 2.15.6
 
 ### Patch Changes

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

@@ -23,7 +23,7 @@ var generateBlockAri = exports.generateBlockAri = function generateBlockAri(sour
 };
 
 /**
- *
+ * 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 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>

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

@@ -177,27 +177,31 @@ var deleteSyncedBlock = exports.deleteSyncedBlock = /*#__PURE__*/function () {
 }();
 var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
   var _ref7 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(_ref6) {
-    var blockAri, content, response;
+    var blockAri, content, stepVersion, requestBody, response;
     return _regenerator.default.wrap(function _callee4$(_context4) {
       while (1) switch (_context4.prev = _context4.next) {
         case 0:
-          blockAri = _ref6.blockAri, content = _ref6.content;
-          _context4.next = 3;
+          blockAri = _ref6.blockAri, content = _ref6.content, stepVersion = _ref6.stepVersion;
+          requestBody = {
+            content: content
+          };
+          if (stepVersion !== undefined) {
+            requestBody.stepVersion = stepVersion;
+          }
+          _context4.next = 5;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block/").concat(encodeURIComponent(blockAri)), {
             method: 'PUT',
             headers: COMMON_HEADERS,
-            body: JSON.stringify({
-              content: content
-            })
+            body: JSON.stringify(requestBody)
           });
-        case 3:
+        case 5:
           response = _context4.sent;
           if (response.ok) {
-            _context4.next = 6;
+            _context4.next = 8;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
+        case 8:
         case "end":
           return _context4.stop();
       }
@@ -209,36 +213,40 @@ var updateSyncedBlock = exports.updateSyncedBlock = /*#__PURE__*/function () {
 }();
 var createSyncedBlock = exports.createSyncedBlock = /*#__PURE__*/function () {
   var _ref9 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(_ref8) {
-    var blockAri, blockInstanceId, sourceAri, product, content, response;
+    var blockAri, blockInstanceId, sourceAri, product, content, stepVersion, requestBody, response;
     return _regenerator.default.wrap(function _callee5$(_context5) {
       while (1) switch (_context5.prev = _context5.next) {
         case 0:
-          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content;
-          _context5.next = 3;
+          blockAri = _ref8.blockAri, blockInstanceId = _ref8.blockInstanceId, sourceAri = _ref8.sourceAri, product = _ref8.product, content = _ref8.content, stepVersion = _ref8.stepVersion;
+          requestBody = {
+            blockAri: blockAri,
+            blockInstanceId: blockInstanceId,
+            sourceAri: sourceAri,
+            product: product,
+            content: content
+          };
+          if (stepVersion !== undefined) {
+            requestBody.stepVersion = stepVersion;
+          }
+          _context5.next = 5;
           return (0, _retry.fetchWithRetry)("".concat(BLOCK_SERVICE_API_URL, "/block"), {
             method: 'POST',
             headers: COMMON_HEADERS,
-            body: JSON.stringify({
-              blockAri: blockAri,
-              blockInstanceId: blockInstanceId,
-              sourceAri: sourceAri,
-              product: product,
-              content: content
-            })
+            body: JSON.stringify(requestBody)
           });
-        case 3:
+        case 5:
           response = _context5.sent;
           if (response.ok) {
-            _context5.next = 6;
+            _context5.next = 8;
             break;
           }
           throw new BlockError(response.status);
-        case 6:
-          _context5.next = 8;
-          return response.json();
         case 8:
+          _context5.next = 10;
+          return response.json();
+        case 10:
           return _context5.abrupt("return", _context5.sent);
-        case 9:
+        case 11:
         case "end":
           return _context5.stop();
       }

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

@@ -3,15 +3,30 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.resourceIdFromConfluencePageSourceIdAndLocalId = exports.getPageIdAndTypeFromConfluencePageAri = exports.getPageARIFromContentPropertyResourceId = exports.getLocalIdFromConfluencePageAri = exports.getConfluencePageAri = void 0;
+exports.resourceIdFromConfluencePageSourceIdAndLocalId = exports.getPageIdAndTypeFromConfluencePageAri = exports.getPageAriFromContentPropertyResourceId = exports.getLocalIdFromContentPropertyResourceId = exports.getConfluencePageAri = void 0;
 /* eslint-disable require-unicode-regexp  */
 
+/**
+ * The type of the Confluence page
+ */
+
+/**
+ * Generates the Confluence page ARI
+ * @param pageId - the ID of the page
+ * @param cloudId - the cloud ID
+ * @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';
   return "ari:cloud:confluence:".concat(cloudId, ":").concat(pageType, "/").concat(pageId);
 };
 
-// For extracting from Page ARI and also the content property's version of resourceId
+/**
+ * Extracts the page ID and type from the Confluence page ARI
+ * @param ari - the Confluence page ARI
+ * @returns the page ID and type
+ */
 var getPageIdAndTypeFromConfluencePageAri = exports.getPageIdAndTypeFromConfluencePageAri = function getPageIdAndTypeFromConfluencePageAri(ari) {
   var match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/(\d+)/);
   if (match !== null && match !== void 0 && match[2]) {
@@ -22,20 +37,39 @@ var getPageIdAndTypeFromConfluencePageAri = exports.getPageIdAndTypeFromConfluen
   }
   throw new Error("Invalid page ARI: ".concat(ari));
 };
-var getLocalIdFromConfluencePageAri = exports.getLocalIdFromConfluencePageAri = function getLocalIdFromConfluencePageAri(ari) {
-  var match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/\d+\/([a-zA-Z0-9-]+)/);
+
+/**
+ * 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 page ARI: ".concat(ari));
+  throw new Error("Invalid resourceId: ".concat(resourceId));
 };
-var getPageARIFromContentPropertyResourceId = exports.getPageARIFromContentPropertyResourceId = function getPageARIFromContentPropertyResourceId(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 sourceId + '/' + localId;
+  return "".concat(sourceId, "/").concat(localId);
 };

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

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getJiraWorkItemIdFromAri = exports.getJiraWorkItemAri = void 0;
+/* eslint-disable require-unicode-regexp  */
+
+/**
+ * Generates the Jira work item ARI
+ * @param workItemId - the ID of the work item
+ * @param cloudId - the cloud ID
+ * @returns the Jira work item ARI
+ */
+var getJiraWorkItemAri = exports.getJiraWorkItemAri = function getJiraWorkItemAri(workItemId, cloudId) {
+  return "ari:cloud:jira:".concat(cloudId, ":issue/").concat(workItemId);
+};
+
+/**
+ * Extracts the Jira work item ID from the Jira work item ARI
+ * @param ari - the Jira work item ARI
+ * @returns the Jira work item ID
+ */
+var getJiraWorkItemIdFromAri = exports.getJiraWorkItemIdFromAri = function getJiraWorkItemIdFromAri(ari) {
+  var match = ari.match(/ari:cloud:jira:([^:]+):issue\/(\d+)/);
+  if (match !== null && match !== void 0 && match[2]) {
+    return match[2];
+  }
+  throw new Error("Invalid Jira work item ARI: ".concat(ari));
+};

package/dist/cjs/index.js

@@ -93,22 +93,34 @@ Object.defineProperty(exports, "getContentIdAndProductFromResourceId", {
     return _utils.getContentIdAndProductFromResourceId;
   }
 });
+Object.defineProperty(exports, "getJiraWorkItemAri", {
+  enumerable: true,
+  get: function get() {
+    return _ari3.getJiraWorkItemAri;
+  }
+});
+Object.defineProperty(exports, "getJiraWorkItemIdFromAri", {
+  enumerable: true,
+  get: function get() {
+    return _ari3.getJiraWorkItemIdFromAri;
+  }
+});
 Object.defineProperty(exports, "getLocalIdFromBlockResourceId", {
   enumerable: true,
   get: function get() {
     return _ari.getLocalIdFromBlockResourceId;
   }
 });
-Object.defineProperty(exports, "getLocalIdFromConfluencePageAri", {
+Object.defineProperty(exports, "getLocalIdFromContentPropertyResourceId", {
   enumerable: true,
   get: function get() {
-    return _ari2.getLocalIdFromConfluencePageAri;
+    return _ari2.getLocalIdFromContentPropertyResourceId;
   }
 });
-Object.defineProperty(exports, "getPageARIFromContentPropertyResourceId", {
+Object.defineProperty(exports, "getPageAriFromContentPropertyResourceId", {
   enumerable: true,
   get: function get() {
-    return _ari2.getPageARIFromContentPropertyResourceId;
+    return _ari2.getPageAriFromContentPropertyResourceId;
   }
 });
 Object.defineProperty(exports, "getPageIdAndTypeFromConfluencePageAri", {
@@ -184,6 +196,7 @@ var _useFetchSyncBlockTitle = require("./hooks/useFetchSyncBlockTitle");
 var _useHandleContentChanges = require("./hooks/useHandleContentChanges");
 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");

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

@@ -196,11 +196,12 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
  * ADFWriteProvider implementation that writes synced block data to Block Service API
  */
 var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
-  function BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId) {
+  function BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion) {
     (0, _classCallCheck2.default)(this, BlockServiceADFWriteProvider);
     this.sourceAri = sourceAri;
     this.product = product;
     this.sourceDocumentId = sourceDocumentId;
+    this.getVersion = getVersion;
   }
 
   // it will first try to update and if it can't (404) then it will try to create
@@ -208,43 +209,45 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     key: "writeData",
     value: function () {
       var _writeData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3(data) {
-        var resourceId, blockAri;
+        var resourceId, blockAri, stepVersion;
         return _regenerator.default.wrap(function _callee3$(_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
               resourceId = data.resourceId;
               blockAri = (0, _ari.generateBlockAri)(this.sourceAri, resourceId, this.product);
-              _context3.prev = 2;
-              _context3.next = 5;
+              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              _context3.prev = 3;
+              _context3.next = 6;
               return (0, _blockService.updateSyncedBlock)({
                 blockAri: blockAri,
-                content: JSON.stringify(data.content)
+                content: JSON.stringify(data.content),
+                stepVersion: stepVersion
               });
-            case 5:
+            case 6:
               return _context3.abrupt("return", {
                 resourceId: resourceId
               });
-            case 8:
-              _context3.prev = 8;
-              _context3.t0 = _context3["catch"](2);
+            case 9:
+              _context3.prev = 9;
+              _context3.t0 = _context3["catch"](3);
               if (!(_context3.t0 instanceof _blockService.BlockError)) {
-                _context3.next = 12;
+                _context3.next = 13;
                 break;
               }
               return _context3.abrupt("return", {
                 error: mapBlockError(_context3.t0),
                 resourceId: resourceId
               });
-            case 12:
+            case 13:
               return _context3.abrupt("return", {
                 error: (0, _errorHandling.stringifyError)(_context3.t0),
                 resourceId: resourceId
               });
-            case 13:
+            case 14:
             case "end":
               return _context3.stop();
           }
-        }, _callee3, this, [[2, 8]]);
+        }, _callee3, this, [[3, 9]]);
       }));
       function writeData(_x3) {
         return _writeData.apply(this, arguments);
@@ -255,46 +258,48 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
     key: "createData",
     value: function () {
       var _createData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(data) {
-        var resourceId, blockAri;
+        var resourceId, blockAri, stepVersion;
         return _regenerator.default.wrap(function _callee4$(_context4) {
           while (1) switch (_context4.prev = _context4.next) {
             case 0:
               resourceId = data.resourceId;
               blockAri = (0, _ari.generateBlockAri)(this.sourceAri, resourceId, this.product);
-              _context4.prev = 2;
-              _context4.next = 5;
+              stepVersion = this.getVersion ? this.getVersion() : undefined;
+              _context4.prev = 3;
+              _context4.next = 6;
               return (0, _blockService.createSyncedBlock)({
                 blockAri: blockAri,
                 blockInstanceId: data.blockInstanceId,
                 sourceAri: this.sourceAri,
                 product: this.product,
-                content: JSON.stringify(data.content)
+                content: JSON.stringify(data.content),
+                stepVersion: stepVersion
               });
-            case 5:
+            case 6:
               return _context4.abrupt("return", {
                 resourceId: resourceId
               });
-            case 8:
-              _context4.prev = 8;
-              _context4.t0 = _context4["catch"](2);
+            case 9:
+              _context4.prev = 9;
+              _context4.t0 = _context4["catch"](3);
               if (!(_context4.t0 instanceof _blockService.BlockError)) {
-                _context4.next = 12;
+                _context4.next = 13;
                 break;
               }
               return _context4.abrupt("return", {
                 error: mapBlockError(_context4.t0),
                 resourceId: resourceId
               });
-            case 12:
+            case 13:
               return _context4.abrupt("return", {
                 error: (0, _errorHandling.stringifyError)(_context4.t0),
                 resourceId: resourceId
               });
-            case 13:
+            case 14:
             case "end":
               return _context4.stop();
           }
-        }, _callee4, this, [[2, 8]]);
+        }, _callee4, this, [[3, 9]]);
       }));
       function createData(_x4) {
         return _createData.apply(this, arguments);
@@ -425,16 +430,16 @@ var BlockServiceADFWriteProvider = /*#__PURE__*/function () {
 /**
  * Factory function to create both providers with shared configuration
  */
-var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId) {
+var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
   var fetchProvider = new BlockServiceADFFetchProvider(sourceAri);
-  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId);
+  var writeProvider = new BlockServiceADFWriteProvider(sourceAri, product, sourceDocumentId, getVersion);
   return {
     fetchProvider: fetchProvider,
     writeProvider: writeProvider
   };
 };
-var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product, sourceDocumentId) {
+var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProviders = function useMemoizedBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion) {
   return (0, _react.useMemo)(function () {
-    return createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId);
-  }, [sourceAri, product, sourceDocumentId]);
+    return createBlockServiceAPIProviders(sourceAri, product, sourceDocumentId, getVersion);
+  }, [sourceAri, product, sourceDocumentId, getVersion]);
 };

package/dist/cjs/providers/confluence/confluenceContentAPI.js

@@ -70,7 +70,7 @@ var ConfluenceADFFetchProvider = /*#__PURE__*/function () {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               _getPageIdAndTypeFrom = (0, _ari.getPageIdAndTypeFromConfluencePageAri)(resourceId), pageId = _getPageIdAndTypeFrom.id, pageType = _getPageIdAndTypeFrom.type;
-              localId = (0, _ari.getLocalIdFromConfluencePageAri)(resourceId);
+              localId = (0, _ari.getLocalIdFromContentPropertyResourceId)(resourceId);
               _context.prev = 2;
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               options = {
@@ -234,7 +234,7 @@ var ConfluenceADFWriteProvider = /*#__PURE__*/function () {
               _match = match, pageId = _match.id, pageType = _match.type;
               _context3.prev = 9;
               // Update existing content property
-              localId = (0, _ari.getLocalIdFromConfluencePageAri)(resourceId);
+              localId = (0, _ari.getLocalIdFromContentPropertyResourceId)(resourceId);
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               sourceAri = (0, _ari.getConfluencePageAri)(pageId, this.config.cloudId, pageType);
               syncBlockDataWithSourceDocumentAri = _objectSpread(_objectSpread({}, syncBlockData), {}, {
@@ -306,7 +306,7 @@ var ConfluenceADFWriteProvider = /*#__PURE__*/function () {
             case 8:
               _match2 = match, pageId = _match2.id, pageType = _match2.type;
               _context4.prev = 9;
-              localId = (0, _ari.getLocalIdFromConfluencePageAri)(resourceId);
+              localId = (0, _ari.getLocalIdFromContentPropertyResourceId)(resourceId);
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               sourceAri = (0, _ari.getConfluencePageAri)(pageId, this.config.cloudId, pageType);
               syncBlockDataWithSourceDocumentAri = _objectSpread(_objectSpread({}, syncBlockData), {}, {
@@ -359,7 +359,7 @@ var ConfluenceADFWriteProvider = /*#__PURE__*/function () {
             case 7:
               _match3 = match, pageId = _match3.id, pageType = _match3.type;
               _context5.prev = 8;
-              localId = (0, _ari.getLocalIdFromConfluencePageAri)(resourceId);
+              localId = (0, _ari.getLocalIdFromContentPropertyResourceId)(resourceId);
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               options = {
                 pageId: pageId,

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

@@ -17,7 +17,7 @@ export const generateBlockAri = (sourceAri, resourceId, product) => {
 };
 
 /**
- *
+ * 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 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>

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

@@ -92,14 +92,19 @@ export const deleteSyncedBlock = async ({
 };
 export const updateSyncedBlock = async ({
   blockAri,
-  content
+  content,
+  stepVersion
 }) => {
+  const requestBody = {
+    content
+  };
+  if (stepVersion !== undefined) {
+    requestBody.stepVersion = stepVersion;
+  }
   const response = await fetchWithRetry(`${BLOCK_SERVICE_API_URL}/block/${encodeURIComponent(blockAri)}`, {
     method: 'PUT',
     headers: COMMON_HEADERS,
-    body: JSON.stringify({
-      content
-    })
+    body: JSON.stringify(requestBody)
   });
   if (!response.ok) {
     throw new BlockError(response.status);
@@ -110,18 +115,23 @@ export const createSyncedBlock = async ({
   blockInstanceId,
   sourceAri,
   product,
-  content
+  content,
+  stepVersion
 }) => {
+  const requestBody = {
+    blockAri,
+    blockInstanceId,
+    sourceAri,
+    product,
+    content
+  };
+  if (stepVersion !== undefined) {
+    requestBody.stepVersion = stepVersion;
+  }
   const response = await fetchWithRetry(`${BLOCK_SERVICE_API_URL}/block`, {
     method: 'POST',
     headers: COMMON_HEADERS,
-    body: JSON.stringify({
-      blockAri,
-      blockInstanceId,
-      sourceAri,
-      product,
-      content
-    })
+    body: JSON.stringify(requestBody)
   });
   if (!response.ok) {
     throw new BlockError(response.status);

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

@@ -1,8 +1,23 @@
 /* eslint-disable require-unicode-regexp  */
 
+/**
+ * The type of the Confluence page
+ */
+
+/**
+ * Generates the Confluence page ARI
+ * @param pageId - the ID of the page
+ * @param cloudId - the cloud ID
+ * @param pageType - the type of the page
+ * @returns the Confluence page ARI
+ */
 export const getConfluencePageAri = (pageId, cloudId, pageType = 'page') => `ari:cloud:confluence:${cloudId}:${pageType}/${pageId}`;
 
-// For extracting from Page ARI and also the content property's version of resourceId
+/**
+ * Extracts the page ID and type from the Confluence page ARI
+ * @param ari - the Confluence page ARI
+ * @returns the page ID and type
+ */
 export const getPageIdAndTypeFromConfluencePageAri = ari => {
   const match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/(\d+)/);
   if (match !== null && match !== void 0 && match[2]) {
@@ -13,20 +28,37 @@ export const getPageIdAndTypeFromConfluencePageAri = ari => {
   }
   throw new Error(`Invalid page ARI: ${ari}`);
 };
-export const getLocalIdFromConfluencePageAri = ari => {
-  const match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/\d+\/([a-zA-Z0-9-]+)/);
+
+/**
+ * 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
+ */
+export const getLocalIdFromContentPropertyResourceId = resourceId => {
+  const 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 page ARI: ${ari}`);
+  throw new Error(`Invalid resourceId: ${resourceId}`);
 };
-export const getPageARIFromContentPropertyResourceId = 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
+ */
+export const getPageAriFromContentPropertyResourceId = resourceId => {
   const 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: ${resourceId}`);
 };
-export const resourceIdFromConfluencePageSourceIdAndLocalId = (sourceId, localId) => {
-  return sourceId + '/' + localId;
-};
+
+/**
+ * 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
+ */
+export const resourceIdFromConfluencePageSourceIdAndLocalId = (sourceId, localId) => `${sourceId}/${localId}`;

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

@@ -0,0 +1,22 @@
+/* eslint-disable require-unicode-regexp  */
+
+/**
+ * Generates the Jira work item ARI
+ * @param workItemId - the ID of the work item
+ * @param cloudId - the cloud ID
+ * @returns the Jira work item ARI
+ */
+export const getJiraWorkItemAri = (workItemId, cloudId) => `ari:cloud:jira:${cloudId}:issue/${workItemId}`;
+
+/**
+ * Extracts the Jira work item ID from the Jira work item ARI
+ * @param ari - the Jira work item ARI
+ * @returns the Jira work item ID
+ */
+export const getJiraWorkItemIdFromAri = ari => {
+  const match = ari.match(/ari:cloud:jira:([^:]+):issue\/(\d+)/);
+  if (match !== null && match !== void 0 && match[2]) {
+    return match[2];
+  }
+  throw new Error(`Invalid Jira work item ARI: ${ari}`);
+};

package/dist/es2019/index.js

@@ -10,7 +10,8 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 
 // clients
 export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId } from './clients/block-service/ari';
-export { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageARIFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from './clients/confluence/ari';
+export { getConfluencePageAri, getLocalIdFromContentPropertyResourceId, getPageAriFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from './clients/confluence/ari';
+export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';
 
 // providers
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';