@atlaskit/editor-synced-block-provider 2.16.0 → 2.16.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @atlaskit/editor-synced-block-provider
 
+## 2.16.2
+
+### Patch Changes
+
+- [`98568bfc82648`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/98568bfc82648) -
+  Export SyncedBlockRendererDataProviders type
+- Updated dependencies
+
+## 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

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/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/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/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';

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

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useMemo } from 'react';
-import { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
+import { getConfluencePageAri, getLocalIdFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
 import { getContentProperty, createContentProperty, updateContentProperty, deleteContentProperty } from '../../clients/confluence/contentProperty';
 import { isBlogPageType } from '../../clients/confluence/utils';
 import { SyncBlockError } from '../../common/types';
@@ -52,7 +52,7 @@ class ConfluenceADFFetchProvider {
       id: pageId,
       type: pageType
     } = getPageIdAndTypeFromConfluencePageAri(resourceId);
-    const localId = getLocalIdFromConfluencePageAri(resourceId);
+    const localId = getLocalIdFromContentPropertyResourceId(resourceId);
     try {
       const key = getContentPropertyKey(this.config.contentPropertyKey, localId);
       const options = {
@@ -162,7 +162,7 @@ class ConfluenceADFWriteProvider {
     } = match;
     try {
       // Update existing content property
-      const localId = getLocalIdFromConfluencePageAri(resourceId);
+      const localId = getLocalIdFromContentPropertyResourceId(resourceId);
       const key = getContentPropertyKey(this.config.contentPropertyKey, localId);
       const sourceAri = getConfluencePageAri(pageId, this.config.cloudId, pageType);
       const syncBlockDataWithSourceDocumentAri = {
@@ -211,7 +211,7 @@ class ConfluenceADFWriteProvider {
       type: pageType
     } = match;
     try {
-      const localId = getLocalIdFromConfluencePageAri(resourceId);
+      const localId = getLocalIdFromContentPropertyResourceId(resourceId);
       const key = getContentPropertyKey(this.config.contentPropertyKey, localId);
       const sourceAri = getConfluencePageAri(pageId, this.config.cloudId, pageType);
       const syncBlockDataWithSourceDocumentAri = {
@@ -245,7 +245,7 @@ class ConfluenceADFWriteProvider {
       type: pageType
     } = match;
     try {
-      const localId = getLocalIdFromConfluencePageAri(resourceId);
+      const localId = getLocalIdFromContentPropertyResourceId(resourceId);
       const key = getContentPropertyKey(this.config.contentPropertyKey, localId);
       const options = {
         pageId,

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

@@ -17,7 +17,7 @@ export var generateBlockAri = function generateBlockAri(sourceAri, resourceId, p
 };
 
 /**
- *
+ * 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/esm/clients/confluence/ari.js

@@ -1,11 +1,26 @@
 /* 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 var 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
+ */
 export var getPageIdAndTypeFromConfluencePageAri = function getPageIdAndTypeFromConfluencePageAri(ari) {
   var match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/(\d+)/);
   if (match !== null && match !== void 0 && match[2]) {
@@ -16,20 +31,39 @@ export var getPageIdAndTypeFromConfluencePageAri = function getPageIdAndTypeFrom
   }
   throw new Error("Invalid page ARI: ".concat(ari));
 };
-export var 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
+ */
+export var 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));
 };
-export var 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
+ */
+export var 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
+ */
 export var resourceIdFromConfluencePageSourceIdAndLocalId = function resourceIdFromConfluencePageSourceIdAndLocalId(sourceId, localId) {
-  return sourceId + '/' + localId;
+  return "".concat(sourceId, "/").concat(localId);
 };

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

@@ -0,0 +1,24 @@
+/* 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 var 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
+ */
+export var 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/esm/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';

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

@@ -7,7 +7,7 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 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 _regeneratorRuntime from "@babel/runtime/regenerator";
 import { useMemo } from 'react';
-import { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
+import { getConfluencePageAri, getLocalIdFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId } from '../../clients/confluence/ari';
 import { getContentProperty, createContentProperty, updateContentProperty, deleteContentProperty } from '../../clients/confluence/contentProperty';
 import { isBlogPageType } from '../../clients/confluence/utils';
 import { SyncBlockError } from '../../common/types';
@@ -64,7 +64,7 @@ var ConfluenceADFFetchProvider = /*#__PURE__*/function () {
           while (1) switch (_context.prev = _context.next) {
             case 0:
               _getPageIdAndTypeFrom = getPageIdAndTypeFromConfluencePageAri(resourceId), pageId = _getPageIdAndTypeFrom.id, pageType = _getPageIdAndTypeFrom.type;
-              localId = getLocalIdFromConfluencePageAri(resourceId);
+              localId = getLocalIdFromContentPropertyResourceId(resourceId);
               _context.prev = 2;
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               options = {
@@ -228,7 +228,7 @@ var ConfluenceADFWriteProvider = /*#__PURE__*/function () {
               _match = match, pageId = _match.id, pageType = _match.type;
               _context3.prev = 9;
               // Update existing content property
-              localId = getLocalIdFromConfluencePageAri(resourceId);
+              localId = getLocalIdFromContentPropertyResourceId(resourceId);
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               sourceAri = getConfluencePageAri(pageId, this.config.cloudId, pageType);
               syncBlockDataWithSourceDocumentAri = _objectSpread(_objectSpread({}, syncBlockData), {}, {
@@ -300,7 +300,7 @@ var ConfluenceADFWriteProvider = /*#__PURE__*/function () {
             case 8:
               _match2 = match, pageId = _match2.id, pageType = _match2.type;
               _context4.prev = 9;
-              localId = getLocalIdFromConfluencePageAri(resourceId);
+              localId = getLocalIdFromContentPropertyResourceId(resourceId);
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               sourceAri = getConfluencePageAri(pageId, this.config.cloudId, pageType);
               syncBlockDataWithSourceDocumentAri = _objectSpread(_objectSpread({}, syncBlockData), {}, {
@@ -353,7 +353,7 @@ var ConfluenceADFWriteProvider = /*#__PURE__*/function () {
             case 7:
               _match3 = match, pageId = _match3.id, pageType = _match3.type;
               _context5.prev = 8;
-              localId = getLocalIdFromConfluencePageAri(resourceId);
+              localId = getLocalIdFromContentPropertyResourceId(resourceId);
               key = getContentPropertyKey(this.config.contentPropertyKey, localId);
               options = {
                 pageId: pageId,

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

@@ -7,7 +7,7 @@ import { type SyncBlockProduct } from '../../common/types';
  */
 export declare const generateBlockAri: (sourceAri: string, resourceId: string, product: SyncBlockProduct) => string;
 /**
- *
+ * 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/types/clients/confluence/ari.d.ts

@@ -1,9 +1,40 @@
+/**
+ * The type of the Confluence page
+ */
 export type PAGE_TYPE = 'page' | 'blogpost';
+/**
+ * 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 declare const getConfluencePageAri: (pageId: string, cloudId: string, pageType?: PAGE_TYPE) => string;
+/**
+ * Extracts the page ID and type from the Confluence page ARI
+ * @param ari - the Confluence page ARI
+ * @returns the page ID and type
+ */
 export declare const getPageIdAndTypeFromConfluencePageAri: (ari: string) => {
     id: string;
     type: PAGE_TYPE;
 };
-export declare const getLocalIdFromConfluencePageAri: (ari: string) => string;
-export declare const getPageARIFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * 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 declare const getLocalIdFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * 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 declare const getPageAriFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * 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 declare const resourceIdFromConfluencePageSourceIdAndLocalId: (sourceId: string, localId: string) => string;

package/dist/types/clients/jira/ari.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 declare const getJiraWorkItemAri: (workItemId: string, cloudId: string) => string;
+/**
+ * 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 declare const getJiraWorkItemIdFromAri: (ari: string) => string;

package/dist/types/index.d.ts

@@ -5,12 +5,13 @@ export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hook
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 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';
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
 export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
-export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, } from './providers/types';
+export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, } from './providers/types';
 export { type ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from './store-manager/syncBlockStoreManager';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

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

@@ -7,7 +7,7 @@ import { type SyncBlockProduct } from '../../common/types';
  */
 export declare const generateBlockAri: (sourceAri: string, resourceId: string, product: SyncBlockProduct) => string;
 /**
- *
+ * 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/types-ts4.5/clients/confluence/ari.d.ts

@@ -1,9 +1,40 @@
+/**
+ * The type of the Confluence page
+ */
 export type PAGE_TYPE = 'page' | 'blogpost';
+/**
+ * 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 declare const getConfluencePageAri: (pageId: string, cloudId: string, pageType?: PAGE_TYPE) => string;
+/**
+ * Extracts the page ID and type from the Confluence page ARI
+ * @param ari - the Confluence page ARI
+ * @returns the page ID and type
+ */
 export declare const getPageIdAndTypeFromConfluencePageAri: (ari: string) => {
     id: string;
     type: PAGE_TYPE;
 };
-export declare const getLocalIdFromConfluencePageAri: (ari: string) => string;
-export declare const getPageARIFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * 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 declare const getLocalIdFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * 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 declare const getPageAriFromContentPropertyResourceId: (resourceId: string) => string;
+/**
+ * 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 declare const resourceIdFromConfluencePageSourceIdAndLocalId: (sourceId: string, localId: string) => string;

package/dist/types-ts4.5/clients/jira/ari.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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 declare const getJiraWorkItemAri: (workItemId: string, cloudId: string) => string;
+/**
+ * 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 declare const getJiraWorkItemIdFromAri: (ari: string) => string;

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

@@ -5,12 +5,13 @@ export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hook
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
 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';
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
 export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
-export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, } from './providers/types';
+export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, } from './providers/types';
 export { type ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from './store-manager/syncBlockStoreManager';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

package/package.json

@@ -33,7 +33,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.49.0",
+		"@atlaskit/editor-common": "^110.50.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -76,7 +76,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.16.0",
+	"version": "2.16.2",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",