@atlaskit/editor-synced-block-provider 15.0.3 → 15.1.0

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

@@ -2,10 +2,11 @@
 
 import { useMemo } from 'react';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
-import { generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
+import { generateBlockAri, generateBlockAriFromReference, getProductFromSourceAri } from '../../clients/block-service/ari';
 import { batchRetrieveSyncedBlocks, BlockError, BlockNotFoundError, BlockTimeoutError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
 import { SyncBlockError } from '../../common/types';
 import { getPiiSafeOriginalError, stringifyError } from '../../utils/errorHandling';
+import { getFieldAwareLocationScope } from '../../utils/fieldAwareLocations';
 import { createResourceIdForReference } from '../../utils/resourceId';
 import { convertContentUpdatedAt } from '../../utils/utils';
 const BLOCK_ARI_TO_RESOURCE_ID_REGEX = /^ari:cloud:blocks:.*:synced-block\/(.+)$/;
@@ -500,12 +501,18 @@ class BlockServiceADFFetchProvider {
       const response = await getReferenceSyncedBlocksByBlockAri({
         blockAri
       });
+      const locationScopeOf = documentAri => getFieldAwareLocationScope({
+        documentAri,
+        hostAri: this.parentAri,
+        productType: getProductFromSourceAri(documentAri)
+      });
       const references = [];
       response.references.forEach(reference => {
         references.push({
           ...reference,
           hasAccess: true,
-          onSameDocument: this.parentAri === reference.documentAri
+          onSameDocument: this.parentAri === reference.documentAri,
+          ...locationScopeOf(reference.documentAri)
         });
       });
       response.errors.forEach(reference => {
@@ -514,7 +521,8 @@ class BlockServiceADFFetchProvider {
             blockAri: reference.blockAri,
             documentAri: reference.documentAri,
             hasAccess: false,
-            onSameDocument: false
+            onSameDocument: false,
+            ...locationScopeOf(reference.documentAri)
           });
         }
       });

package/dist/es2019/providers/syncBlockProvider.js

@@ -5,6 +5,7 @@ import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
 import { fetchJiraWorkItemInfo } from '../clients/jira/sourceInfo';
 import { SyncBlockError } from '../common/types';
+import { getFieldAwareLocationScope } from '../utils/fieldAwareLocations';
 import { SyncBlockDataProviderInterface } from './types';
 export class SyncedBlockProvider extends SyncBlockDataProviderInterface {
   /**
@@ -217,7 +218,7 @@ export class SyncedBlockProvider extends SyncBlockDataProviderInterface {
         }
       case 'jira-work-item':
         {
-          var _this$writeProvider4;
+          var _this$writeProvider4, _this$writeProvider5;
           // Note: `subType`, archived URL handling, and `isUnpublished` are intentionally
           // omitted here — Jira work items have no equivalent page subtype or archived state.
           // The `localId` param is intentionally not forwarded: the current Jira issue view
@@ -231,6 +232,11 @@ export class SyncedBlockProvider extends SyncBlockDataProviderInterface {
           return {
             ...sourceInfo,
             onSameDocument: ((_this$writeProvider4 = this.writeProvider) === null || _this$writeProvider4 === void 0 ? void 0 : _this$writeProvider4.parentAri) === ari,
+            ...getFieldAwareLocationScope({
+              documentAri: ari,
+              hostAri: (_this$writeProvider5 = this.writeProvider) === null || _this$writeProvider5 === void 0 ? void 0 : _this$writeProvider5.parentAri,
+              productType: product
+            }),
             productType: product
           };
         }

package/dist/es2019/store-manager/referenceSyncBlockStoreManager.js

@@ -309,6 +309,8 @@ export class ReferenceSyncBlockStoreManager {
         sourceURL,
         sourceTitle,
         onSameDocument,
+        fieldName,
+        locationScope,
         sourceSubType,
         issueType
       } = existingSyncBlock.data || {};
@@ -320,6 +322,12 @@ export class ReferenceSyncBlockStoreManager {
           subType: sourceSubType,
           sourceAri: sourceAri || '',
           onSameDocument,
+          ...(fieldName !== undefined && {
+            fieldName
+          }),
+          ...(locationScope !== undefined && {
+            locationScope
+          }),
           productType: product,
           issueType
         });
@@ -599,6 +607,12 @@ export class ReferenceSyncBlockStoreManager {
         sourceURL: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.url,
         sourceTitle: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.title,
         onSameDocument: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.onSameDocument,
+        ...((sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.fieldName) !== undefined && {
+          fieldName: sourceInfo.fieldName
+        }),
+        ...((sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.locationScope) !== undefined && {
+          locationScope: sourceInfo.locationScope
+        }),
         sourceSubType: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.subType,
         issueType: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.issueType
       };

package/dist/es2019/store-manager/syncBlockStoreManager.js

@@ -64,6 +64,9 @@ export class SyncBlockStoreManager {
         return {
           ...sourceInfo,
           onSameDocument: reference.onSameDocument,
+          ...(reference.locationScope !== undefined && {
+            locationScope: reference.locationScope
+          }),
           hasAccess: reference.hasAccess,
           productType: sourceInfo.productType
         };

package/dist/es2019/utils/fieldAwareLocations.js

@@ -0,0 +1,21 @@
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
+import { getLocationScope } from '../clients/block-service/ari';
+/**
+ * The product check runs first so a Confluence-only document never reads the experiment.
+ */
+export const isFieldAwareJiraLocation = productType => productType === 'jira-work-item' && isExperimentEnabled('editor_synced_blocks_jira_custom_rich_text');
+
+/**
+ * Spreadable `{ locationScope }` for a location that should carry one, `undefined` otherwise.
+ * Without a host ARI there is nothing to compare against, so the experiment is not read.
+ */
+export const getFieldAwareLocationScope = ({
+  documentAri,
+  hostAri,
+  productType
+}) => hostAri !== undefined && isFieldAwareJiraLocation(productType) ? {
+  locationScope: getLocationScope({
+    documentAri,
+    hostAri
+  })
+} : undefined;

package/dist/es2019/utils/resolveSyncBlockInstance.js

@@ -12,7 +12,7 @@ import { SyncBlockError } from '../common/types';
  * @returns A merged SyncBlockInstance object.
  */
 export const resolveSyncBlockInstance = (oldResult, newResult) => {
-  var _newResult$data, _oldResult$data, _newResult$data2, _oldResult$data2, _newResult$data3, _oldResult$data3, _newResult$data4, _oldResult$data4;
+  var _newResult$data$field, _newResult$data$locat, _newResult$data, _oldResult$data, _newResult$data2, _oldResult$data2, _newResult$data3, _oldResult$data3, _newResult$data4, _oldResult$data4;
   // if the old result has no data, we simply return the new result
   if (!oldResult.data) {
     return newResult;
@@ -27,6 +27,8 @@ export const resolveSyncBlockInstance = (oldResult, newResult) => {
   }
 
   // otherwise, we merge the two results, preserving the sourceURL and sourceTitle from the old result if it exists
+  const fieldName = (_newResult$data$field = newResult.data.fieldName) !== null && _newResult$data$field !== void 0 ? _newResult$data$field : oldResult.data.fieldName;
+  const locationScope = (_newResult$data$locat = newResult.data.locationScope) !== null && _newResult$data$locat !== void 0 ? _newResult$data$locat : oldResult.data.locationScope;
   return {
     ...newResult,
     data: {
@@ -35,7 +37,13 @@ export const resolveSyncBlockInstance = (oldResult, newResult) => {
       sourceTitle: ((_newResult$data2 = newResult.data) === null || _newResult$data2 === void 0 ? void 0 : _newResult$data2.sourceTitle) || ((_oldResult$data2 = oldResult.data) === null || _oldResult$data2 === void 0 ? void 0 : _oldResult$data2.sourceTitle) || undefined,
       sourceSubType: mergeSubType(oldResult, newResult),
       onSameDocument: ((_newResult$data3 = newResult.data) === null || _newResult$data3 === void 0 ? void 0 : _newResult$data3.onSameDocument) || ((_oldResult$data3 = oldResult.data) === null || _oldResult$data3 === void 0 ? void 0 : _oldResult$data3.onSameDocument) || undefined,
-      issueType: ((_newResult$data4 = newResult.data) === null || _newResult$data4 === void 0 ? void 0 : _newResult$data4.issueType) || ((_oldResult$data4 = oldResult.data) === null || _oldResult$data4 === void 0 ? void 0 : _oldResult$data4.issueType) || undefined
+      issueType: ((_newResult$data4 = newResult.data) === null || _newResult$data4 === void 0 ? void 0 : _newResult$data4.issueType) || ((_oldResult$data4 = oldResult.data) === null || _oldResult$data4 === void 0 ? void 0 : _oldResult$data4.issueType) || undefined,
+      ...(fieldName !== undefined && {
+        fieldName
+      }),
+      ...(locationScope !== undefined && {
+        locationScope
+      })
     }
   };
 };

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

@@ -1,5 +1,6 @@
 /* eslint-disable require-unicode-regexp */
 
+import { parseJiraFieldLocation } from '../jira/ari';
 var GET_LOCAL_ID_FROM_BLOCK_RESOURCE_ID_REGEX = /ari:cloud:blocks:[^:]+:synced-block\/([a-zA-Z0-9-]+)/;
 var JIRA_SOURCE_ARI_REGEX = /ari:cloud:jira:.*/;
 var CONFLUENCE_SOURCE_ARI_REGEX = /ari:cloud:confluence:.*/;
@@ -46,6 +47,32 @@ export var getLocalIdFromBlockResourceId = function getLocalIdFromBlockResourceI
   }
   throw new Error("Invalid block ARI: ".concat(ari));
 };
+
+/**
+ * Where `documentAri` sits relative to the document hosting the editor.
+ *
+ * Jira admits two ARI forms for one work item field: `issuefieldvalue/{issueId}/{fieldId}`
+ * names any field, and a plain issue ARI names the description field. Jira's own
+ * `isParentAriValid` accepts either as a host, so the two are compared on the field they
+ * denote rather than as strings.
+ */
+export var getLocationScope = function getLocationScope(_ref3) {
+  var documentAri = _ref3.documentAri,
+    hostAri = _ref3.hostAri;
+  if (documentAri === hostAri) {
+    return 'same-document';
+  }
+  var location = parseJiraFieldLocation({
+    ari: documentAri
+  });
+  var hostLocation = parseJiraFieldLocation({
+    ari: hostAri
+  });
+  if (!location || !hostLocation || location.issueAri !== hostLocation.issueAri) {
+    return 'elsewhere';
+  }
+  return location.fieldId === hostLocation.fieldId ? 'same-document' : 'same-parent-document';
+};
 export var getProductFromSourceAri = function getProductFromSourceAri(ari) {
   var jiraMatch = ari === null || ari === void 0 ? void 0 : ari.search(JIRA_SOURCE_ARI_REGEX);
   if (jiraMatch !== -1) {

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

@@ -62,4 +62,39 @@ export var getJiraIssueAriFromSourceAri = function getJiraIssueAriFromSourceAri(
     });
   }
   return ari;
+};
+var JIRA_DESCRIPTION_FIELD_ID = 'description';
+
+/**
+ * One synced block location on a Jira work item, parsed once from its document ARI.
+ * Two locations name the same field when both members match, whichever of the two ARI
+ * forms each was written in.
+ */
+
+var toJiraFieldLocation = function toJiraFieldLocation(_ref4) {
+  var cloudId = _ref4.cloudId,
+    fieldId = _ref4.fieldId,
+    issueId = _ref4.issueId;
+  return {
+    fieldId: fieldId,
+    issueAri: getJiraWorkItemAri({
+      cloudId: cloudId,
+      workItemId: issueId
+    })
+  };
+};
+
+/** A plain issue ARI is the work item's description field. */
+export var parseJiraFieldLocation = function parseJiraFieldLocation(_ref5) {
+  var ari = _ref5.ari;
+  var workItemMatch = ari.match(JIRA_WORK_ITEM_ARI_REGEX);
+  if (workItemMatch !== null && workItemMatch !== void 0 && workItemMatch[1] && workItemMatch[2]) {
+    return toJiraFieldLocation({
+      cloudId: workItemMatch[1],
+      fieldId: JIRA_DESCRIPTION_FIELD_ID,
+      issueId: workItemMatch[2]
+    });
+  }
+  var fieldValueParts = getFieldValueAriParts(ari);
+  return fieldValueParts && toJiraFieldLocation(fieldValueParts);
 };

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

@@ -5,8 +5,9 @@ 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; }
 /* eslint-disable require-unicode-regexp  */
 
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { fetchWithRetry } from '../../utils/retry';
-import { getJiraIssueAriFromSourceAri } from './ari';
+import { getJiraIssueAriFromSourceAri, parseJiraFieldLocation } from './ari';
 var COMMON_HEADERS = {
   'Content-Type': 'application/json',
   Accept: 'application/json'
@@ -24,16 +25,33 @@ var GET_SOURCE_INFO_OPERATION_NAME = 'EDITOR_SYNCED_BLOCK_GET_SOURCE_INFO';
 // `issueType` is requested alongside `summary` and `webUrl` so the
 // SyncedLocationDropdown can render the correct ADS issue-type icon.
 var GET_SOURCE_INFO_QUERY = "query ".concat(GET_SOURCE_INFO_OPERATION_NAME, " ($id: ID!) {\n  jira {\n\tissueById(id: $id) {\n\tid\n\twebUrl\n\tsummary\n\tissueType {\n\t\tname\n\t\tavatar {\n\t\txsmall\n\t\t}\n\t}\n\t}\n  }}");
+// `fieldsById(ids:)` takes bare field ids, the same shape it returns on `node.fieldId`.
+// Its schema doc gives `issuefieldvalue` ARIs as the example, but AGG resolves those to a
+// null node. Verified against hello.atlassian.net by sending an ARI and a bare id together.
+var GET_SOURCE_INFO_WITH_FIELD_QUERY = "query ".concat(GET_SOURCE_INFO_OPERATION_NAME, " ($id: ID!, $fieldIds: [ID!]!) {\n  jira {\n\tissueById(id: $id) {\n\tid\n\twebUrl\n\tsummary\n\tissueType {\n\t\tname\n\t\tavatar {\n\t\txsmall\n\t\t}\n\t}\n\tfieldsById(ids: $fieldIds) {\n\t\tedges {\n\t\tnode {\n\t\t\tfieldId\n\t\t\tname\n\t\t}\n\t\t}\n\t}\n\t}\n  }}");
+
+// AGG does not promise `edges` follows the order of the requested ids.
+var getFieldName = function getFieldName(contentData, fieldId) {
+  var _contentData$fieldsBy;
+  var name = contentData === null || contentData === void 0 || (_contentData$fieldsBy = contentData.fieldsById) === null || _contentData$fieldsBy === void 0 || (_contentData$fieldsBy = _contentData$fieldsBy.edges) === null || _contentData$fieldsBy === void 0 || (_contentData$fieldsBy = _contentData$fieldsBy.find(function (edge) {
+    var _edge$node;
+    return (edge === null || edge === void 0 || (_edge$node = edge.node) === null || _edge$node === void 0 ? void 0 : _edge$node.fieldId) === fieldId;
+  })) === null || _contentData$fieldsBy === void 0 || (_contentData$fieldsBy = _contentData$fieldsBy.node) === null || _contentData$fieldsBy === void 0 ? void 0 : _contentData$fieldsBy.name;
+  return typeof name === 'string' && name.length > 0 ? name : undefined;
+};
 var getJiraWorkItemSourceInfo = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(issueAri) {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(issueAri, fieldId) {
     var bodyData, response;
     return _regeneratorRuntime.wrap(function (_context) {
       while (1) switch (_context.prev = _context.next) {
         case 0:
           bodyData = {
-            query: GET_SOURCE_INFO_QUERY,
+            query: fieldId ? GET_SOURCE_INFO_WITH_FIELD_QUERY : GET_SOURCE_INFO_QUERY,
             operationName: GET_SOURCE_INFO_OPERATION_NAME,
-            variables: {
+            variables: fieldId ? {
+              id: issueAri,
+              fieldIds: [fieldId]
+            } : {
               id: issueAri
             }
           };
@@ -61,7 +79,7 @@ var getJiraWorkItemSourceInfo = /*#__PURE__*/function () {
       }
     }, _callee);
   }));
-  return function getJiraWorkItemSourceInfo(_x) {
+  return function getJiraWorkItemSourceInfo(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -107,7 +125,7 @@ var resolveNoAccessWorkItemInfo = /*#__PURE__*/function () {
       }
     }, _callee2);
   }));
-  return function resolveNoAccessWorkItemInfo(_x2, _x3) {
+  return function resolveNoAccessWorkItemInfo(_x3, _x4) {
     return _ref2.apply(this, arguments);
   };
 }();
@@ -134,7 +152,7 @@ var resolveNoAccessWorkItemInfo = /*#__PURE__*/function () {
  */
 export var fetchJiraWorkItemInfo = /*#__PURE__*/function () {
   var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(workItemAri, hasAccess) {
-    var issueAri, _response$data, _contentData$issueTyp, _contentData$issueTyp2, response, contentData, webUrl, summary, issueTypeName, issueType;
+    var issueAri, _response$data, _contentData$issueTyp, _contentData$issueTyp2, fieldLocation, response, contentData, webUrl, summary, issueTypeName, issueType, fieldName;
     return _regeneratorRuntime.wrap(function (_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
@@ -147,8 +165,11 @@ export var fetchJiraWorkItemInfo = /*#__PURE__*/function () {
             _context3.next = 2;
             break;
           }
+          fieldLocation = isExperimentEnabled('editor_synced_blocks_jira_custom_rich_text') ? parseJiraFieldLocation({
+            ari: workItemAri
+          }) : undefined;
           _context3.next = 1;
-          return getJiraWorkItemSourceInfo(issueAri);
+          return getJiraWorkItemSourceInfo(issueAri, fieldLocation === null || fieldLocation === void 0 ? void 0 : fieldLocation.fieldId);
         case 1:
           response = _context3.sent;
           contentData = (_response$data = response.data) === null || _response$data === void 0 || (_response$data = _response$data.jira) === null || _response$data === void 0 ? void 0 : _response$data.issueById;
@@ -161,12 +182,15 @@ export var fetchJiraWorkItemInfo = /*#__PURE__*/function () {
             name: issueTypeName,
             iconUrl: typeof (contentData === null || contentData === void 0 || (_contentData$issueTyp2 = contentData.issueType) === null || _contentData$issueTyp2 === void 0 || (_contentData$issueTyp2 = _contentData$issueTyp2.avatar) === null || _contentData$issueTyp2 === void 0 ? void 0 : _contentData$issueTyp2.xsmall) === 'string' ? contentData.issueType.avatar.xsmall : undefined
           } : undefined;
-          return _context3.abrupt("return", Promise.resolve({
+          fieldName = fieldLocation && getFieldName(contentData, fieldLocation.fieldId);
+          return _context3.abrupt("return", Promise.resolve(_objectSpread({
             url: webUrl,
             sourceAri: workItemAri,
             title: summary,
             issueType: issueType
-          }));
+          }, fieldName !== undefined && {
+            fieldName: fieldName
+          })));
         case 2:
           _context3.next = 3;
           return resolveNoAccessWorkItemInfo(workItemAri, issueAri);
@@ -178,7 +202,7 @@ export var fetchJiraWorkItemInfo = /*#__PURE__*/function () {
       }
     }, _callee3);
   }));
-  return function fetchJiraWorkItemInfo(_x4, _x5) {
+  return function fetchJiraWorkItemInfo(_x5, _x6) {
     return _ref3.apply(this, arguments);
   };
 }();

package/dist/esm/common/types.js

@@ -8,6 +8,12 @@ import _wrapNativeSuper from "@babel/runtime/helpers/wrapNativeSuper";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 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; })(); }
+/**
+ * Where a synced block location sits relative to the document hosting the editor.
+ * `same-document` is the host document itself, the same page or the same work item field.
+ * `same-parent-document` is another field of the host work item.
+ */
+
 export var SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";

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

@@ -13,10 +13,11 @@ import _regeneratorRuntime from "@babel/runtime/regenerator";
 
 import { useMemo } from 'react';
 import { expValEquals } from '@atlaskit/tmp-editor-statsig/exp-val-equals';
-import { generateBlockAri as _generateBlockAri, generateBlockAriFromReference } from '../../clients/block-service/ari';
+import { generateBlockAri as _generateBlockAri, generateBlockAriFromReference, getProductFromSourceAri } from '../../clients/block-service/ari';
 import { batchRetrieveSyncedBlocks, BlockError, BlockNotFoundError, BlockTimeoutError, createSyncedBlock, deleteSyncedBlock, getReferenceSyncedBlocks, getReferenceSyncedBlocksByBlockAri, getSyncedBlockContent, updateReferenceSyncedBlockOnDocument, updateSyncedBlock, updateSyncedBlocks } from '../../clients/block-service/blockService';
 import { SyncBlockError } from '../../common/types';
 import { getPiiSafeOriginalError, stringifyError } from '../../utils/errorHandling';
+import { getFieldAwareLocationScope } from '../../utils/fieldAwareLocations';
 import { createResourceIdForReference } from '../../utils/resourceId';
 import { convertContentUpdatedAt } from '../../utils/utils';
 var BLOCK_ARI_TO_RESOURCE_ID_REGEX = /^ari:cloud:blocks:.*:synced-block\/(.+)$/;
@@ -695,7 +696,7 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
     value: function () {
       var _fetchReferences = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee5(referenceResourceId) {
         var _this = this;
-        var blockAri, response, references, _t8;
+        var blockAri, response, locationScopeOf, references, _t8;
         return _regeneratorRuntime.wrap(function (_context6) {
           while (1) switch (_context6.prev = _context6.next) {
             case 0:
@@ -710,21 +711,28 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
               });
             case 1:
               response = _context6.sent;
+              locationScopeOf = function locationScopeOf(documentAri) {
+                return getFieldAwareLocationScope({
+                  documentAri: documentAri,
+                  hostAri: _this.parentAri,
+                  productType: getProductFromSourceAri(documentAri)
+                });
+              };
               references = [];
               response.references.forEach(function (reference) {
                 references.push(_objectSpread(_objectSpread({}, reference), {}, {
                   hasAccess: true,
                   onSameDocument: _this.parentAri === reference.documentAri
-                }));
+                }, locationScopeOf(reference.documentAri)));
               });
               response.errors.forEach(function (reference) {
                 if (reference.code === 'FORBIDDEN') {
-                  references.push({
+                  references.push(_objectSpread({
                     blockAri: reference.blockAri,
                     documentAri: reference.documentAri,
                     hasAccess: false,
                     onSameDocument: false
-                  });
+                  }, locationScopeOf(reference.documentAri)));
                 }
               });
               return _context6.abrupt("return", {

package/dist/esm/providers/syncBlockProvider.js

@@ -17,6 +17,7 @@ import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
 import { fetchJiraWorkItemInfo } from '../clients/jira/sourceInfo';
 import { SyncBlockError } from '../common/types';
+import { getFieldAwareLocationScope } from '../utils/fieldAwareLocations';
 import { SyncBlockDataProviderInterface } from './types';
 export var SyncedBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
   /**
@@ -313,6 +314,7 @@ export var SyncedBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
           _this$writeProvider2,
           sourceInfo,
           _this$writeProvider3,
+          _this$writeProvider4,
           _sourceInfo,
           _args4 = arguments,
           _t2;
@@ -357,8 +359,13 @@ export var SyncedBlockProvider = /*#__PURE__*/function (_SyncBlockDataProvide) {
               }
               return _context4.abrupt("return", Promise.resolve(undefined));
             case 7:
-              return _context4.abrupt("return", _objectSpread(_objectSpread({}, _sourceInfo), {}, {
-                onSameDocument: ((_this$writeProvider3 = this.writeProvider) === null || _this$writeProvider3 === void 0 ? void 0 : _this$writeProvider3.parentAri) === ari,
+              return _context4.abrupt("return", _objectSpread(_objectSpread(_objectSpread({}, _sourceInfo), {}, {
+                onSameDocument: ((_this$writeProvider3 = this.writeProvider) === null || _this$writeProvider3 === void 0 ? void 0 : _this$writeProvider3.parentAri) === ari
+              }, getFieldAwareLocationScope({
+                documentAri: ari,
+                hostAri: (_this$writeProvider4 = this.writeProvider) === null || _this$writeProvider4 === void 0 ? void 0 : _this$writeProvider4.parentAri,
+                productType: product
+              })), {}, {
                 productType: product
               }));
             case 8:

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

@@ -394,19 +394,26 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
           sourceURL = _ref.sourceURL,
           sourceTitle = _ref.sourceTitle,
           onSameDocument = _ref.onSameDocument,
+          fieldName = _ref.fieldName,
+          locationScope = _ref.locationScope,
           sourceSubType = _ref.sourceSubType,
           issueType = _ref.issueType;
         // skip if source URL and title are already present
         if (sourceURL && sourceTitle) {
-          return Promise.resolve({
+          return Promise.resolve(_objectSpread(_objectSpread(_objectSpread({
             title: sourceTitle,
             url: sourceURL,
             subType: sourceSubType,
             sourceAri: sourceAri || '',
-            onSameDocument: onSameDocument,
+            onSameDocument: onSameDocument
+          }, fieldName !== undefined && {
+            fieldName: fieldName
+          }), locationScope !== undefined && {
+            locationScope: locationScope
+          }), {}, {
             productType: product,
             issueType: issueType
-          });
+          }));
         }
 
         // Derive once per call so we don't re-parse on every analytics event below.
@@ -725,10 +732,15 @@ export var ReferenceSyncBlockStoreManager = /*#__PURE__*/function () {
       }
       if (existingSyncBlock && existingSyncBlock.data) {
         existingSyncBlock.data.sourceURL = sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.url;
-        existingSyncBlock.data = _objectSpread(_objectSpread({}, existingSyncBlock.data), {}, {
+        existingSyncBlock.data = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, existingSyncBlock.data), {}, {
           sourceURL: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.url,
           sourceTitle: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.title,
-          onSameDocument: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.onSameDocument,
+          onSameDocument: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.onSameDocument
+        }, (sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.fieldName) !== undefined && {
+          fieldName: sourceInfo.fieldName
+        }), (sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.locationScope) !== undefined && {
+          locationScope: sourceInfo.locationScope
+        }), {}, {
           sourceSubType: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.subType,
           issueType: sourceInfo === null || sourceInfo === void 0 ? void 0 : sourceInfo.issueType
         });

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

@@ -99,8 +99,11 @@ export var SyncBlockStoreManager = /*#__PURE__*/function () {
                         return _context.abrupt("return", undefined);
                       case 2:
                         (_this$fetchSourceInfo3 = _this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo3 === void 0 || _this$fetchSourceInfo3.success();
-                        return _context.abrupt("return", _objectSpread(_objectSpread({}, sourceInfo), {}, {
-                          onSameDocument: reference.onSameDocument,
+                        return _context.abrupt("return", _objectSpread(_objectSpread(_objectSpread({}, sourceInfo), {}, {
+                          onSameDocument: reference.onSameDocument
+                        }, reference.locationScope !== undefined && {
+                          locationScope: reference.locationScope
+                        }), {}, {
                           hasAccess: reference.hasAccess,
                           productType: sourceInfo.productType
                         }));

package/dist/esm/utils/fieldAwareLocations.js

@@ -0,0 +1,24 @@
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
+import { getLocationScope } from '../clients/block-service/ari';
+/**
+ * The product check runs first so a Confluence-only document never reads the experiment.
+ */
+export var isFieldAwareJiraLocation = function isFieldAwareJiraLocation(productType) {
+  return productType === 'jira-work-item' && isExperimentEnabled('editor_synced_blocks_jira_custom_rich_text');
+};
+
+/**
+ * Spreadable `{ locationScope }` for a location that should carry one, `undefined` otherwise.
+ * Without a host ARI there is nothing to compare against, so the experiment is not read.
+ */
+export var getFieldAwareLocationScope = function getFieldAwareLocationScope(_ref) {
+  var documentAri = _ref.documentAri,
+    hostAri = _ref.hostAri,
+    productType = _ref.productType;
+  return hostAri !== undefined && isFieldAwareJiraLocation(productType) ? {
+    locationScope: getLocationScope({
+      documentAri: documentAri,
+      hostAri: hostAri
+    })
+  } : undefined;
+};

package/dist/esm/utils/resolveSyncBlockInstance.js

@@ -15,7 +15,7 @@ import { SyncBlockError } from '../common/types';
  * @returns A merged SyncBlockInstance object.
  */
 export var resolveSyncBlockInstance = function resolveSyncBlockInstance(oldResult, newResult) {
-  var _newResult$data, _oldResult$data, _newResult$data2, _oldResult$data2, _newResult$data3, _oldResult$data3, _newResult$data4, _oldResult$data4;
+  var _newResult$data$field, _newResult$data$locat, _newResult$data, _oldResult$data, _newResult$data2, _oldResult$data2, _newResult$data3, _oldResult$data3, _newResult$data4, _oldResult$data4;
   // if the old result has no data, we simply return the new result
   if (!oldResult.data) {
     return newResult;
@@ -30,13 +30,19 @@ export var resolveSyncBlockInstance = function resolveSyncBlockInstance(oldResul
   }
 
   // otherwise, we merge the two results, preserving the sourceURL and sourceTitle from the old result if it exists
+  var fieldName = (_newResult$data$field = newResult.data.fieldName) !== null && _newResult$data$field !== void 0 ? _newResult$data$field : oldResult.data.fieldName;
+  var locationScope = (_newResult$data$locat = newResult.data.locationScope) !== null && _newResult$data$locat !== void 0 ? _newResult$data$locat : oldResult.data.locationScope;
   return _objectSpread(_objectSpread({}, newResult), {}, {
-    data: _objectSpread(_objectSpread({}, newResult.data), {}, {
+    data: _objectSpread(_objectSpread(_objectSpread({}, newResult.data), {}, {
       sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined,
       sourceTitle: ((_newResult$data2 = newResult.data) === null || _newResult$data2 === void 0 ? void 0 : _newResult$data2.sourceTitle) || ((_oldResult$data2 = oldResult.data) === null || _oldResult$data2 === void 0 ? void 0 : _oldResult$data2.sourceTitle) || undefined,
       sourceSubType: mergeSubType(oldResult, newResult),
       onSameDocument: ((_newResult$data3 = newResult.data) === null || _newResult$data3 === void 0 ? void 0 : _newResult$data3.onSameDocument) || ((_oldResult$data3 = oldResult.data) === null || _oldResult$data3 === void 0 ? void 0 : _oldResult$data3.onSameDocument) || undefined,
       issueType: ((_newResult$data4 = newResult.data) === null || _newResult$data4 === void 0 ? void 0 : _newResult$data4.issueType) || ((_oldResult$data4 = oldResult.data) === null || _oldResult$data4 === void 0 ? void 0 : _oldResult$data4.issueType) || undefined
+    }, fieldName !== undefined && {
+      fieldName: fieldName
+    }), locationScope !== undefined && {
+      locationScope: locationScope
     })
   });
 };

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

@@ -1,4 +1,4 @@
-import type { SyncBlockProduct } from '../../common/types';
+import type { SyncBlockLocationScope, SyncBlockProduct } from '../../common/types';
 /**
  * Generates the block ARI from the source page ARI and the source block's resource ID.
  * @param cloudId - the cloudId of the block. E.G the cloudId of the confluence page, or the cloudId of the Jira instance
@@ -31,4 +31,16 @@ export declare const generateBlockAriFromReference: ({ cloudId, resourceId, }: {
  * @returns the localId of the block node. A randomly generated UUID
  */
 export declare const getLocalIdFromBlockResourceId: (ari: string) => string;
+/**
+ * Where `documentAri` sits relative to the document hosting the editor.
+ *
+ * Jira admits two ARI forms for one work item field: `issuefieldvalue/{issueId}/{fieldId}`
+ * names any field, and a plain issue ARI names the description field. Jira's own
+ * `isParentAriValid` accepts either as a host, so the two are compared on the field they
+ * denote rather than as strings.
+ */
+export declare const getLocationScope: ({ documentAri, hostAri, }: {
+    documentAri: string;
+    hostAri: string;
+}) => SyncBlockLocationScope;
 export declare const getProductFromSourceAri: (ari?: string) => SyncBlockProduct | undefined;

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

@@ -26,3 +26,18 @@ export declare const getJiraWorkItemIdFromAri: ({ ari }: {
 export declare const getJiraIssueAriFromSourceAri: ({ ari }: {
     ari: string;
 }) => string;
+/**
+ * One synced block location on a Jira work item, parsed once from its document ARI.
+ * Two locations name the same field when both members match, whichever of the two ARI
+ * forms each was written in.
+ */
+export type JiraFieldLocation = Readonly<{
+    /** Bare field id, the shape AGG `fieldsById(ids:)` takes and returns. */
+    fieldId: string;
+    /** Parent issue ARI. `issueById` and the object resolver take this one. */
+    issueAri: string;
+}>;
+/** A plain issue ARI is the work item's description field. */
+export declare const parseJiraFieldLocation: ({ ari }: {
+    ari: string;
+}) => JiraFieldLocation | undefined;