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

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @atlaskit/editor-synced-block-provider
 
+## 15.1.1
+
+### Patch Changes
+
+- Updated dependencies
+
+## 15.1.0
+
+### Minor Changes
+
+- [`8062c64320986`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8062c64320986) -
+  EDITOR-9184: Resolve the Jira work item field holding a synced block and where each location sits
+  relative to the host document, behind the `editor_synced_blocks_jira_custom_rich_text` experiment.
+  `SyncBlockSourceInfo` gains optional `fieldName` and `locationScope`, `ReferenceSyncBlock` and
+  `SyncBlockData` gain optional `locationScope`, and the new `SyncBlockLocationScope` type is
+  exported from `common/types`; with the experiment off the AGG request and every returned object
+  are unchanged.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 15.0.3
 
 ### Patch Changes

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

@@ -3,7 +3,8 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getProductFromSourceAri = exports.getLocalIdFromBlockResourceId = exports.generateBlockAriFromReference = exports.generateBlockAri = void 0;
+exports.getProductFromSourceAri = exports.getLocationScope = exports.getLocalIdFromBlockResourceId = exports.generateBlockAriFromReference = exports.generateBlockAri = void 0;
+var _ari = require("../jira/ari");
 /* eslint-disable require-unicode-regexp */
 
 var GET_LOCAL_ID_FROM_BLOCK_RESOURCE_ID_REGEX = /ari:cloud:blocks:[^:]+:synced-block\/([a-zA-Z0-9-]+)/;
@@ -52,6 +53,32 @@ var getLocalIdFromBlockResourceId = exports.getLocalIdFromBlockResourceId = func
   }
   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.
+ */
+var getLocationScope = exports.getLocationScope = function getLocationScope(_ref3) {
+  var documentAri = _ref3.documentAri,
+    hostAri = _ref3.hostAri;
+  if (documentAri === hostAri) {
+    return 'same-document';
+  }
+  var location = (0, _ari.parseJiraFieldLocation)({
+    ari: documentAri
+  });
+  var hostLocation = (0, _ari.parseJiraFieldLocation)({
+    ari: hostAri
+  });
+  if (!location || !hostLocation || location.issueAri !== hostLocation.issueAri) {
+    return 'elsewhere';
+  }
+  return location.fieldId === hostLocation.fieldId ? 'same-document' : 'same-parent-document';
+};
 var getProductFromSourceAri = exports.getProductFromSourceAri = function getProductFromSourceAri(ari) {
   var jiraMatch = ari === null || ari === void 0 ? void 0 : ari.search(JIRA_SOURCE_ARI_REGEX);
   if (jiraMatch !== -1) {

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getJiraWorkItemIdFromAri = exports.getJiraWorkItemAri = exports.getJiraIssueAriFromSourceAri = void 0;
+exports.parseJiraFieldLocation = exports.getJiraWorkItemIdFromAri = exports.getJiraWorkItemAri = exports.getJiraIssueAriFromSourceAri = void 0;
 /* eslint-disable require-unicode-regexp  */
 
 var JIRA_WORK_ITEM_ARI_REGEX = /ari:cloud:jira:([^:]+):issue\/(\d+)/;
@@ -68,4 +68,39 @@ var getJiraIssueAriFromSourceAri = exports.getJiraIssueAriFromSourceAri = functi
     });
   }
   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. */
+var parseJiraFieldLocation = exports.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/cjs/clients/jira/sourceInfo.js

@@ -8,6 +8,7 @@ exports.fetchJiraWorkItemInfo = void 0;
 var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _retry = require("../../utils/retry");
 var _ari = require("./ari");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
@@ -29,16 +30,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 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(issueAri) {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(issueAri, fieldId) {
     var bodyData, response;
     return _regenerator.default.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
             }
           };
@@ -66,7 +84,7 @@ var getJiraWorkItemSourceInfo = /*#__PURE__*/function () {
       }
     }, _callee);
   }));
-  return function getJiraWorkItemSourceInfo(_x) {
+  return function getJiraWorkItemSourceInfo(_x, _x2) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -112,7 +130,7 @@ var resolveNoAccessWorkItemInfo = /*#__PURE__*/function () {
       }
     }, _callee2);
   }));
-  return function resolveNoAccessWorkItemInfo(_x2, _x3) {
+  return function resolveNoAccessWorkItemInfo(_x3, _x4) {
     return _ref2.apply(this, arguments);
   };
 }();
@@ -139,7 +157,7 @@ var resolveNoAccessWorkItemInfo = /*#__PURE__*/function () {
  */
 var fetchJiraWorkItemInfo = exports.fetchJiraWorkItemInfo = /*#__PURE__*/function () {
   var _ref3 = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.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 _regenerator.default.wrap(function (_context3) {
       while (1) switch (_context3.prev = _context3.next) {
         case 0:
@@ -152,8 +170,11 @@ var fetchJiraWorkItemInfo = exports.fetchJiraWorkItemInfo = /*#__PURE__*/functio
             _context3.next = 2;
             break;
           }
+          fieldLocation = (0, _isExperimentEnabled.isExperimentEnabled)('editor_synced_blocks_jira_custom_rich_text') ? (0, _ari.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;
@@ -166,12 +187,15 @@ var fetchJiraWorkItemInfo = exports.fetchJiraWorkItemInfo = /*#__PURE__*/functio
             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);
@@ -183,7 +207,7 @@ var fetchJiraWorkItemInfo = exports.fetchJiraWorkItemInfo = /*#__PURE__*/functio
       }
     }, _callee3);
   }));
-  return function fetchJiraWorkItemInfo(_x4, _x5) {
+  return function fetchJiraWorkItemInfo(_x5, _x6) {
     return _ref3.apply(this, arguments);
   };
 }();

package/dist/cjs/common/types.js

@@ -15,6 +15,11 @@ var _wrapNativeSuper2 = _interopRequireDefault(require("@babel/runtime/helpers/w
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+/**
+ * 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.
+ */
 var SyncBlockError = exports.SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";

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

@@ -18,6 +18,7 @@ var _ari = require("../../clients/block-service/ari");
 var _blockService = require("../../clients/block-service/blockService");
 var _types = require("../../common/types");
 var _errorHandling = require("../../utils/errorHandling");
+var _fieldAwareLocations = require("../../utils/fieldAwareLocations");
 var _resourceId2 = require("../../utils/resourceId");
 var _utils = require("../../utils/utils");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t19 in e) "default" !== _t19 && {}.hasOwnProperty.call(e, _t19) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t19)) && (i.get || i.set) ? o(f, _t19, i) : f[_t19] = e[_t19]); return f; })(e, t); }
@@ -701,7 +702,7 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
     value: function () {
       var _fetchReferences = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee5(referenceResourceId) {
         var _this = this;
-        var blockAri, response, references, _t8;
+        var blockAri, response, locationScopeOf, references, _t8;
         return _regenerator.default.wrap(function (_context6) {
           while (1) switch (_context6.prev = _context6.next) {
             case 0:
@@ -716,21 +717,28 @@ var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
               });
             case 1:
               response = _context6.sent;
+              locationScopeOf = function locationScopeOf(documentAri) {
+                return (0, _fieldAwareLocations.getFieldAwareLocationScope)({
+                  documentAri: documentAri,
+                  hostAri: _this.parentAri,
+                  productType: (0, _ari.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/cjs/providers/syncBlockProvider.js

@@ -20,6 +20,7 @@ var _ari2 = require("../clients/confluence/ari");
 var _sourceInfo2 = require("../clients/confluence/sourceInfo");
 var _sourceInfo3 = require("../clients/jira/sourceInfo");
 var _types = require("../common/types");
+var _fieldAwareLocations = require("../utils/fieldAwareLocations");
 var _types2 = require("./types");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -320,6 +321,7 @@ var SyncedBlockProvider = exports.SyncedBlockProvider = /*#__PURE__*/function (_
           _this$writeProvider2,
           sourceInfo,
           _this$writeProvider3,
+          _this$writeProvider4,
           _sourceInfo,
           _args4 = arguments,
           _t2;
@@ -364,8 +366,13 @@ var SyncedBlockProvider = exports.SyncedBlockProvider = /*#__PURE__*/function (_
               }
               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
+              }, (0, _fieldAwareLocations.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/cjs/store-manager/referenceSyncBlockStoreManager.js

@@ -401,19 +401,26 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
           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.
@@ -732,10 +739,15 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       }
       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/cjs/store-manager/syncBlockStoreManager.js

@@ -104,8 +104,11 @@ var SyncBlockStoreManager = exports.SyncBlockStoreManager = /*#__PURE__*/functio
                         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/cjs/utils/fieldAwareLocations.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isFieldAwareJiraLocation = exports.getFieldAwareLocationScope = void 0;
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
+var _ari = require("../clients/block-service/ari");
+/**
+ * The product check runs first so a Confluence-only document never reads the experiment.
+ */
+var isFieldAwareJiraLocation = exports.isFieldAwareJiraLocation = function isFieldAwareJiraLocation(productType) {
+  return productType === 'jira-work-item' && (0, _isExperimentEnabled.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.
+ */
+var getFieldAwareLocationScope = exports.getFieldAwareLocationScope = function getFieldAwareLocationScope(_ref) {
+  var documentAri = _ref.documentAri,
+    hostAri = _ref.hostAri,
+    productType = _ref.productType;
+  return hostAri !== undefined && isFieldAwareJiraLocation(productType) ? {
+    locationScope: (0, _ari.getLocationScope)({
+      documentAri: documentAri,
+      hostAri: hostAri
+    })
+  } : undefined;
+};

package/dist/cjs/utils/resolveSyncBlockInstance.js

@@ -22,7 +22,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
  * @returns A merged SyncBlockInstance object.
  */
 var resolveSyncBlockInstance = exports.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;
@@ -37,13 +37,19 @@ var resolveSyncBlockInstance = exports.resolveSyncBlockInstance = function resol
   }
 
   // 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/es2019/clients/block-service/ari.js

@@ -1,5 +1,6 @@
 /* eslint-disable require-unicode-regexp */
 
+import { parseJiraFieldLocation } from '../jira/ari';
 const GET_LOCAL_ID_FROM_BLOCK_RESOURCE_ID_REGEX = /ari:cloud:blocks:[^:]+:synced-block\/([a-zA-Z0-9-]+)/;
 const JIRA_SOURCE_ARI_REGEX = /ari:cloud:jira:.*/;
 const CONFLUENCE_SOURCE_ARI_REGEX = /ari:cloud:confluence:.*/;
@@ -48,6 +49,33 @@ export const getLocalIdFromBlockResourceId = ari => {
   }
   throw new Error(`Invalid block ARI: ${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 const getLocationScope = ({
+  documentAri,
+  hostAri
+}) => {
+  if (documentAri === hostAri) {
+    return 'same-document';
+  }
+  const location = parseJiraFieldLocation({
+    ari: documentAri
+  });
+  const hostLocation = parseJiraFieldLocation({
+    ari: hostAri
+  });
+  if (!location || !hostLocation || location.issueAri !== hostLocation.issueAri) {
+    return 'elsewhere';
+  }
+  return location.fieldId === hostLocation.fieldId ? 'same-document' : 'same-parent-document';
+};
 export const getProductFromSourceAri = ari => {
   const jiraMatch = ari === null || ari === void 0 ? void 0 : ari.search(JIRA_SOURCE_ARI_REGEX);
   if (jiraMatch !== -1) {

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

@@ -65,4 +65,39 @@ export const getJiraIssueAriFromSourceAri = ({
     });
   }
   return ari;
+};
+const 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.
+ */
+
+const toJiraFieldLocation = ({
+  cloudId,
+  fieldId,
+  issueId
+}) => ({
+  fieldId,
+  issueAri: getJiraWorkItemAri({
+    cloudId,
+    workItemId: issueId
+  })
+});
+
+/** A plain issue ARI is the work item's description field. */
+export const parseJiraFieldLocation = ({
+  ari
+}) => {
+  const 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]
+    });
+  }
+  const fieldValueParts = getFieldValueAriParts(ari);
+  return fieldValueParts && toJiraFieldLocation(fieldValueParts);
 };

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

@@ -1,7 +1,8 @@
 /* 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';
 const COMMON_HEADERS = {
   'Content-Type': 'application/json',
   Accept: 'application/json'
@@ -32,11 +33,49 @@ const GET_SOURCE_INFO_QUERY = `query ${GET_SOURCE_INFO_OPERATION_NAME} ($id: ID!
 	}
 	}
   }}`;
-const getJiraWorkItemSourceInfo = async issueAri => {
+// `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.
+const GET_SOURCE_INFO_WITH_FIELD_QUERY = `query ${GET_SOURCE_INFO_OPERATION_NAME} ($id: ID!, $fieldIds: [ID!]!) {
+  jira {
+	issueById(id: $id) {
+	id
+	webUrl
+	summary
+	issueType {
+		name
+		avatar {
+		xsmall
+		}
+	}
+	fieldsById(ids: $fieldIds) {
+		edges {
+		node {
+			fieldId
+			name
+		}
+		}
+	}
+	}
+  }}`;
+
+// AGG does not promise `edges` follows the order of the requested ids.
+const getFieldName = (contentData, fieldId) => {
+  var _contentData$fieldsBy, _contentData$fieldsBy2, _contentData$fieldsBy3, _contentData$fieldsBy4;
+  const name = contentData === null || contentData === void 0 ? void 0 : (_contentData$fieldsBy = contentData.fieldsById) === null || _contentData$fieldsBy === void 0 ? void 0 : (_contentData$fieldsBy2 = _contentData$fieldsBy.edges) === null || _contentData$fieldsBy2 === void 0 ? void 0 : (_contentData$fieldsBy3 = _contentData$fieldsBy2.find(edge => {
+    var _edge$node;
+    return (edge === null || edge === void 0 ? void 0 : (_edge$node = edge.node) === null || _edge$node === void 0 ? void 0 : _edge$node.fieldId) === fieldId;
+  })) === null || _contentData$fieldsBy3 === void 0 ? void 0 : (_contentData$fieldsBy4 = _contentData$fieldsBy3.node) === null || _contentData$fieldsBy4 === void 0 ? void 0 : _contentData$fieldsBy4.name;
+  return typeof name === 'string' && name.length > 0 ? name : undefined;
+};
+const getJiraWorkItemSourceInfo = async (issueAri, fieldId) => {
   const 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
     }
   };
@@ -107,7 +146,10 @@ export const fetchJiraWorkItemInfo = async (workItemAri, hasAccess) => {
   });
   if (hasAccess) {
     var _response$data, _response$data$jira, _contentData$issueTyp, _contentData$issueTyp2, _contentData$issueTyp3;
-    const response = await getJiraWorkItemSourceInfo(issueAri);
+    const fieldLocation = isExperimentEnabled('editor_synced_blocks_jira_custom_rich_text') ? parseJiraFieldLocation({
+      ari: workItemAri
+    }) : undefined;
+    const response = await getJiraWorkItemSourceInfo(issueAri, fieldLocation === null || fieldLocation === void 0 ? void 0 : fieldLocation.fieldId);
     const contentData = (_response$data = response.data) === null || _response$data === void 0 ? void 0 : (_response$data$jira = _response$data.jira) === null || _response$data$jira === void 0 ? void 0 : _response$data$jira.issueById;
     const webUrl = typeof (contentData === null || contentData === void 0 ? void 0 : contentData.webUrl) === 'string' ? contentData.webUrl : undefined;
     const summary = typeof (contentData === null || contentData === void 0 ? void 0 : contentData.summary) === 'string' ? contentData.summary : undefined;
@@ -120,11 +162,15 @@ export const fetchJiraWorkItemInfo = async (workItemAri, hasAccess) => {
       name: issueTypeName,
       iconUrl: typeof (contentData === null || contentData === void 0 ? void 0 : (_contentData$issueTyp2 = contentData.issueType) === null || _contentData$issueTyp2 === void 0 ? void 0 : (_contentData$issueTyp3 = _contentData$issueTyp2.avatar) === null || _contentData$issueTyp3 === void 0 ? void 0 : _contentData$issueTyp3.xsmall) === 'string' ? contentData.issueType.avatar.xsmall : undefined
     } : undefined;
+    const fieldName = fieldLocation && getFieldName(contentData, fieldLocation.fieldId);
     return Promise.resolve({
       url: webUrl,
       sourceAri: workItemAri,
       title: summary,
-      issueType
+      issueType,
+      ...(fieldName !== undefined && {
+        fieldName
+      })
     });
   } else {
     return await resolveNoAccessWorkItemInfo(workItemAri, issueAri);

package/dist/es2019/common/types.js

@@ -1,4 +1,10 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/**
+ * 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 let SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";