@atlaskit/editor-synced-block-provider 23.0.5 → 23.1.1

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @atlaskit/editor-synced-block-provider
 
+## 23.1.1
+
+### Patch Changes
+
+- [`b68ccfbea3aeb`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/b68ccfbea3aeb) -
+  Generate synced-block reference IDs through the fetch provider under
+  platform_editor_blocks_patch_12, allowing fetch-only renderers to check same-document references
+  without a write provider.
+- Updated dependencies
+
+## 23.1.0
+
+### Minor Changes
+
+- [`bf97ae26b480d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bf97ae26b480d) -
+  Add a `sourceLocation` analytics attribute (`description` | `custom-field`) to synced block create
+  and get-source-info events for Jira sources, behind the `platform_editor_blocks_patch_13` feature
+  gate and the `editor_synced_blocks_jira_custom_rich_text` experiment. With the gate off, events
+  are unchanged. Add an optional `getParentAri()` method to the synced block data provider.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 23.0.5
 
 ### Patch Changes

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.parseJiraFieldLocation = exports.getJiraWorkItemIdFromAri = exports.getJiraWorkItemAri = exports.getJiraIssueAriFromSourceAri = void 0;
+exports.parseJiraFieldLocation = exports.getJiraWorkItemIdFromAri = exports.getJiraWorkItemAri = exports.getJiraIssueAriFromSourceAri = exports.JIRA_DESCRIPTION_FIELD_ID = void 0;
 /* eslint-disable require-unicode-regexp  */
 
 var JIRA_WORK_ITEM_ARI_REGEX = /ari:cloud:jira:([^:]+):issue\/(\d+)/;
@@ -69,7 +69,7 @@ var getJiraIssueAriFromSourceAri = exports.getJiraIssueAriFromSourceAri = functi
   }
   return ari;
 };
-var JIRA_DESCRIPTION_FIELD_ID = 'description';
+var JIRA_DESCRIPTION_FIELD_ID = exports.JIRA_DESCRIPTION_FIELD_ID = 'description';
 
 /**
  * One synced block location on a Jira work item, parsed once from its document ARI.

package/dist/cjs/common/types.js

@@ -20,6 +20,7 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
  * `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.
  */
+/** Which Jira work item field holds a source block. */
 var SyncBlockError = exports.SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";

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

@@ -606,15 +606,27 @@ var writeDataBatch = exports.writeDataBatch = /*#__PURE__*/function () {
 var BlockServiceADFFetchProvider = /*#__PURE__*/function () {
   function BlockServiceADFFetchProvider(_ref5) {
     var cloudId = _ref5.cloudId,
-      parentAri = _ref5.parentAri;
+      parentAri = _ref5.parentAri,
+      parentId = _ref5.parentId,
+      product = _ref5.product;
     (0, _classCallCheck2.default)(this, BlockServiceADFFetchProvider);
     this.cloudId = cloudId;
     this.parentAri = parentAri;
+    this.parentId = parentId;
+    this.product = product;
   }
-
-  // resourceId of the reference synced block.
-  // the ARI must be constructed to call the block service API
   return (0, _createClass2.default)(BlockServiceADFFetchProvider, [{
+    key: "generateResourceIdForReference",
+    value: function generateResourceIdForReference(sourceId) {
+      if (!this.product || !this.parentId) {
+        return sourceId;
+      }
+      return (0, _resourceId2.createResourceIdForReference)(this.product, this.parentId, sourceId);
+    }
+
+    // resourceId of the reference synced block.
+    // the ARI must be constructed to call the block service API
+  }, {
     key: "fetchData",
     value: function () {
       var _fetchData = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee4(resourceId) {
@@ -1496,7 +1508,9 @@ var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(_re
   return {
     fetchProvider: new BlockServiceADFFetchProvider({
       cloudId: cloudId,
-      parentAri: parentAri
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product
     }),
     writeProvider: new BlockServiceADFWriteProvider({
       cloudId: cloudId,
@@ -1525,11 +1539,15 @@ var useMemoizedBlockServiceAPIProviders = exports.useMemoizedBlockServiceAPIProv
 };
 var createBlockServiceFetchOnlyAPIProvider = function createBlockServiceFetchOnlyAPIProvider(_ref1) {
   var cloudId = _ref1.cloudId,
-    parentAri = _ref1.parentAri;
+    parentAri = _ref1.parentAri,
+    parentId = _ref1.parentId,
+    product = _ref1.product;
   return {
     fetchProvider: new BlockServiceADFFetchProvider({
       cloudId: cloudId,
-      parentAri: parentAri
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product
     }),
     writeProvider: undefined
   };
@@ -1540,11 +1558,15 @@ var createBlockServiceFetchOnlyAPIProvider = function createBlockServiceFetchOnl
  */
 var useMemoizedBlockServiceFetchOnlyAPIProvider = exports.useMemoizedBlockServiceFetchOnlyAPIProvider = function useMemoizedBlockServiceFetchOnlyAPIProvider(_ref10) {
   var cloudId = _ref10.cloudId,
-    parentAri = _ref10.parentAri;
+    parentAri = _ref10.parentAri,
+    parentId = _ref10.parentId,
+    product = _ref10.product;
   return (0, _react.useMemo)(function () {
     return createBlockServiceFetchOnlyAPIProvider({
       cloudId: cloudId,
-      parentAri: parentAri
+      parentAri: parentAri,
+      parentId: parentId,
+      product: product
     });
-  }, [cloudId, parentAri]);
+  }, [cloudId, parentAri, parentId, product]);
 };

package/dist/cjs/providers/syncBlockProvider.js

@@ -15,6 +15,7 @@ var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/ge
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _react = require("react");
+var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
 var _ari = require("../clients/block-service/ari");
 var _ari2 = require("../clients/confluence/ari");
 var _sourceInfo2 = require("../clients/confluence/sourceInfo");
@@ -388,6 +389,12 @@ var SyncedBlockProvider = exports.SyncedBlockProvider = /*#__PURE__*/function (_
       }
       return fetchSyncBlockSourceInfo;
     }())
+  }, {
+    key: "getParentAri",
+    value: function getParentAri() {
+      var _this$writeProvider5;
+      return (_this$writeProvider5 = this.writeProvider) === null || _this$writeProvider5 === void 0 ? void 0 : _this$writeProvider5.parentAri;
+    }
   }, {
     key: "generateResourceId",
     value: function generateResourceId() {
@@ -398,14 +405,13 @@ var SyncedBlockProvider = exports.SyncedBlockProvider = /*#__PURE__*/function (_
         resourceId: resourceId
       };
     }
-  }, {
-    key: "canGenerateResourceIdForReference",
-    value: function canGenerateResourceIdForReference() {
-      return this.writeProvider !== undefined;
-    }
   }, {
     key: "generateResourceIdForReference",
     value: function generateResourceIdForReference(sourceId) {
+      if ((0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_blocks_patch_12')) {
+        var _this$fetchProvider$g, _this$fetchProvider$g2, _this$fetchProvider;
+        return (_this$fetchProvider$g = (_this$fetchProvider$g2 = (_this$fetchProvider = this.fetchProvider).generateResourceIdForReference) === null || _this$fetchProvider$g2 === void 0 ? void 0 : _this$fetchProvider$g2.call(_this$fetchProvider, sourceId)) !== null && _this$fetchProvider$g !== void 0 ? _this$fetchProvider$g : sourceId;
+      }
       if (!this.writeProvider) {
         throw new Error('Write provider not set');
       }

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

@@ -18,6 +18,7 @@ var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-ex
 var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
 var _experienceTracking = require("../utils/experienceTracking");
+var _fieldAwareLocations = require("../utils/fieldAwareLocations");
 var _resolveSyncBlockInstance = require("../utils/resolveSyncBlockInstance");
 var _resourceId = require("../utils/resourceId");
 var _utils = require("../utils/utils");
@@ -272,9 +273,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "getSameDocumentReferenceParts",
     value: function getSameDocumentReferenceParts(resourceId) {
-      var _this$dataProvider$ca, _this$dataProvider3;
       var parsed = (0, _resourceId.parseResourceId)(resourceId);
-      if (!parsed || !this.dataProvider || (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_blocks_patch_12') && ((_this$dataProvider$ca = (_this$dataProvider3 = this.dataProvider).canGenerateResourceIdForReference) === null || _this$dataProvider$ca === void 0 ? void 0 : _this$dataProvider$ca.call(_this$dataProvider3)) === false || this.dataProvider.generateResourceIdForReference(parsed.uuid) !== resourceId) {
+      if (!parsed || !this.dataProvider || this.dataProvider.generateResourceIdForReference(parsed.uuid) !== resourceId) {
         return undefined;
       }
       return parsed;
@@ -440,15 +440,26 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
           (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, (0, _errorHandling.getSourceInfoErrorPayload)('SourceAri, product or blockInstanceId missing', resourceId, sourceProduct));
           return Promise.resolve(undefined);
         }
+        var sourceLocation = (0, _fieldAwareLocations.getSourceLocation)(sourceAri);
+        // Undefined with `platform_editor_blocks_patch_13` off, so experience calls below keep
+        // exactly their previous arguments (no `metadata` key, `success()` without arguments).
+        var experienceMetadata = sourceLocation && {
+          sourceLocation: sourceLocation
+        };
+        var withExperienceMetadata = function withExperienceMetadata(options) {
+          return experienceMetadata ? _objectSpread(_objectSpread({}, options), {}, {
+            metadata: experienceMetadata
+          }) : options;
+        };
         (_this$fetchSourceInfo = this.fetchSourceInfoExperience) === null || _this$fetchSourceInfo === void 0 || _this$fetchSourceInfo.start({});
         var sourceInfoPromise = this.dataProvider.fetchSyncBlockSourceInfo(blockInstanceId, sourceAri, product, true // hasAccess
         ).then(function (sourceInfo) {
           if (!sourceInfo) {
             var _this2$fetchSourceInf, _this2$fireAnalyticsE;
-            (_this2$fetchSourceInf = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf === void 0 || _this2$fetchSourceInf.failure({
+            (_this2$fetchSourceInf = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf === void 0 || _this2$fetchSourceInf.failure(withExperienceMetadata({
               reason: 'No source info returned'
-            });
-            (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, (0, _errorHandling.getSourceInfoErrorPayload)('No source info returned', resourceId, sourceProduct));
+            }));
+            (_this2$fireAnalyticsE = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE === void 0 || _this2$fireAnalyticsE.call(_this2, (0, _errorHandling.getSourceInfoErrorPayload)('No source info returned', resourceId, sourceProduct, sourceLocation));
             return undefined;
           }
           _this2.updateCacheWithSourceInfo(resourceId, sourceInfo);
@@ -456,22 +467,29 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
             _this2._subscriptionManager.updateSourceTitleSubscriptions(resourceId, sourceInfo.title);
           }
           if (sourceInfo.title && sourceInfo.url) {
-            var _this2$fetchSourceInf2;
-            (_this2$fetchSourceInf2 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf2 === void 0 || _this2$fetchSourceInf2.success();
+            if (experienceMetadata) {
+              var _this2$fetchSourceInf2;
+              (_this2$fetchSourceInf2 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf2 === void 0 || _this2$fetchSourceInf2.success({
+                metadata: experienceMetadata
+              });
+            } else {
+              var _this2$fetchSourceInf3;
+              (_this2$fetchSourceInf3 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf3 === void 0 || _this2$fetchSourceInf3.success();
+            }
           } else {
-            var _this2$fetchSourceInf3, _this2$fireAnalyticsE2;
-            (_this2$fetchSourceInf3 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf3 === void 0 || _this2$fetchSourceInf3.failure({
+            var _this2$fetchSourceInf4, _this2$fireAnalyticsE2;
+            (_this2$fetchSourceInf4 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf4 === void 0 || _this2$fetchSourceInf4.failure(withExperienceMetadata({
               reason: 'Missing title or url'
-            });
-            (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, (0, _errorHandling.getSourceInfoErrorPayload)('Missing title or url', resourceId, sourceProduct));
+            }));
+            (_this2$fireAnalyticsE2 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE2 === void 0 || _this2$fireAnalyticsE2.call(_this2, (0, _errorHandling.getSourceInfoErrorPayload)('Missing title or url', resourceId, sourceProduct, sourceLocation));
           }
           return sourceInfo;
         }).catch(function (error) {
-          var _this2$fetchSourceInf4, _this2$fireAnalyticsE3;
-          (_this2$fetchSourceInf4 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf4 === void 0 || _this2$fetchSourceInf4.failure({
+          var _this2$fetchSourceInf5, _this2$fireAnalyticsE3;
+          (_this2$fetchSourceInf5 = _this2.fetchSourceInfoExperience) === null || _this2$fetchSourceInf5 === void 0 || _this2$fetchSourceInf5.failure(withExperienceMetadata({
             reason: error.message
-          });
-          (_this2$fireAnalyticsE3 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE3 === void 0 || _this2$fireAnalyticsE3.call(_this2, (0, _errorHandling.getSourceInfoErrorPayload)(error.message, resourceId, sourceProduct));
+          }));
+          (_this2$fireAnalyticsE3 = _this2.fireAnalyticsEvent) === null || _this2$fireAnalyticsE3 === void 0 || _this2$fireAnalyticsE3.call(_this2, (0, _errorHandling.getSourceInfoErrorPayload)(error.message, resourceId, sourceProduct, sourceLocation));
           return undefined;
         }).finally(function () {
           _this2.syncBlockSourceInfoRequests.delete(resourceId);
@@ -768,8 +786,8 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       var sanitizedSyncBlock = this.normalizeReferenceData(syncBlock);
       var resourceId = sanitizedSyncBlock.resourceId;
       if (resourceId) {
-        var _this$dataProvider4;
-        (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 || _this$dataProvider4.updateCache((0, _defineProperty2.default)({}, resourceId, sanitizedSyncBlock), {
+        var _this$dataProvider3;
+        (_this$dataProvider3 = this.dataProvider) === null || _this$dataProvider3 === void 0 || _this$dataProvider3.updateCache((0, _defineProperty2.default)({}, resourceId, sanitizedSyncBlock), {
           strategy: 'merge',
           source: 'network'
         });
@@ -780,15 +798,15 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "getFromCache",
     value: function getFromCache(resourceId) {
-      var _this$dataProvider5;
+      var _this$dataProvider4;
       var syncBlockNode = (0, _utils.createSyncBlockNode)('', resourceId);
-      return (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 || (_this$dataProvider5 = _this$dataProvider5.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider5 === void 0 ? void 0 : _this$dataProvider5.data;
+      return (_this$dataProvider4 = this.dataProvider) === null || _this$dataProvider4 === void 0 || (_this$dataProvider4 = _this$dataProvider4.getNodeDataFromCache(syncBlockNode)) === null || _this$dataProvider4 === void 0 ? void 0 : _this$dataProvider4.data;
     }
   }, {
     key: "deleteFromCache",
     value: function deleteFromCache(resourceId) {
-      var _this$dataProvider6;
-      (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 || _this$dataProvider6.removeFromCache([resourceId]);
+      var _this$dataProvider5;
+      (_this$dataProvider5 = this.dataProvider) === null || _this$dataProvider5 === void 0 || _this$dataProvider5.removeFromCache([resourceId]);
       this._providerFactoryManager.deleteFactory(resourceId);
       // Evict in-flight source-info promise and reset reschedule counter
       // so a stale resolution can't silently merge into a re-fetched entry.
@@ -1272,7 +1290,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
   }, {
     key: "destroy",
     value: function destroy() {
-      var _this$dataProvider7, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo2;
+      var _this$dataProvider6, _this$saveExperience5, _this$fetchExperience0, _this$fetchSourceInfo2;
       // Mark destroyed first so in-flight timer callbacks can early-return.
       this.isDestroyed = true;
 
@@ -1298,7 +1316,7 @@ var ReferenceSyncBlockStoreManager = exports.ReferenceSyncBlockStoreManager = /*
       this._subscriptionManager.destroy();
       this._providerFactoryManager.destroy();
       this._batchFetcher.destroy();
-      (_this$dataProvider7 = this.dataProvider) === null || _this$dataProvider7 === void 0 || _this$dataProvider7.resetCache();
+      (_this$dataProvider6 = this.dataProvider) === null || _this$dataProvider6 === void 0 || _this$dataProvider6.resetCache();
       this.dataProvider = undefined;
       this.syncBlockFetchDataRequests.clear();
       this.syncBlockSourceInfoRequests.clear();

package/dist/cjs/store-manager/sourceSyncBlockStoreManager.js

@@ -18,6 +18,7 @@ var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-ex
 var _types = require("../common/types");
 var _errorHandling = require("../utils/errorHandling");
 var _experienceTracking = require("../utils/experienceTracking");
+var _fieldAwareLocations = require("../utils/fieldAwareLocations");
 var _utils = require("../utils/utils");
 var _excluded = ["contentFragment", "isDirty"];
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t.return || t.return(); } finally { if (u) throw o; } } }; }
@@ -494,16 +495,17 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         }
       } else {
         var _this$fireAnalyticsEv3;
-        (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, (0, _errorHandling.createErrorPayload)('creation complete callback missing', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+        (_this$fireAnalyticsEv3 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv3 === void 0 || _this$fireAnalyticsEv3.call(this, (0, _errorHandling.createErrorPayload)('creation complete callback missing', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId), undefined, this.getSourceLocation()));
       }
       if (success) {
         var _this$dataProvider$ge, _this$dataProvider, _this$fireAnalyticsEv4, _this$fireAnalyticsEv5, _this$syncBlockCache$2;
         var sourceProduct = (0, _utils.getSourceProductFromResourceIdSafe)(resourceId);
+        var sourceLocation = this.getSourceLocation();
         var documentInsertedResourceId = (_this$dataProvider$ge = (_this$dataProvider = this.dataProvider) === null || _this$dataProvider === void 0 ? void 0 : _this$dataProvider.generateResourceIdForReference(resourceId)) !== null && _this$dataProvider$ge !== void 0 ? _this$dataProvider$ge : resourceId;
-        (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, (0, _errorHandling.createSuccessPayload)(documentInsertedResourceId || '', sourceProduct));
+        (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, (0, _errorHandling.createSuccessPayload)(documentInsertedResourceId || '', sourceProduct, sourceLocation));
         // Operational create-success event with the join key + creation-type
         // signals (inputMethod / createdEmpty / nodeTypes) captured at the command layer.
-        (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, (0, _errorHandling.createSuccessOperationalPayload)(resourceId || '', (_this$syncBlockCache$2 = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$2 === void 0 ? void 0 : _this$syncBlockCache$2.blockInstanceId, sourceProduct, this.creationEnrichment.get(resourceId)));
+        (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, (0, _errorHandling.createSuccessOperationalPayload)(resourceId || '', (_this$syncBlockCache$2 = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$2 === void 0 ? void 0 : _this$syncBlockCache$2.blockInstanceId, sourceProduct, this.creationEnrichment.get(resourceId), sourceLocation));
       } else {
         var _this$fireAnalyticsEv6;
         // Delete the node from cache if fail to create so it's not flushed to BE
@@ -513,7 +515,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         // Creation failed, so there is no block to add content to — drop the
         // first-content tracking entry so a later unrelated edit cannot fire it.
         this.awaitingFirstContent.delete(resourceId || '');
-        (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 || _this$fireAnalyticsEv6.call(this, (0, _errorHandling.createErrorPayload)('Fail to create bodied sync block', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+        (_this$fireAnalyticsEv6 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv6 === void 0 || _this$fireAnalyticsEv6.call(this, (0, _errorHandling.createErrorPayload)('Fail to create bodied sync block', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId), undefined, this.getSourceLocation()));
       }
       // Enrichment is single-use — drop it once the create has resolved either way.
       this.creationEnrichment.delete(resourceId || '');
@@ -635,7 +637,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
             (_this5$createExperien2 = _this5.createExperience) === null || _this5$createExperien2 === void 0 || _this5$createExperien2.failure({
               reason: result.error || 'Failed to create bodied sync block'
             });
-            (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, (0, _errorHandling.createErrorPayload)(result.error || 'Failed to create bodied sync block', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId), (0, _errorHandling.buildErrorAttribution)(result.error, result.statusCode)));
+            (_this5$fireAnalyticsE = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE === void 0 || _this5$fireAnalyticsE.call(_this5, (0, _errorHandling.createErrorPayload)(result.error || 'Failed to create bodied sync block', resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId), (0, _errorHandling.buildErrorAttribution)(result.error, result.statusCode), _this5.getSourceLocation()));
           }
         }).catch(function (error) {
           var _this5$createExperien3, _this5$fireAnalyticsE2;
@@ -646,7 +648,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
           (_this5$createExperien3 = _this5.createExperience) === null || _this5$createExperien3 === void 0 || _this5$createExperien3.failure({
             reason: error.message
           });
-          (_this5$fireAnalyticsE2 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE2 === void 0 || _this5$fireAnalyticsE2.call(_this5, (0, _errorHandling.createErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+          (_this5$fireAnalyticsE2 = _this5.fireAnalyticsEvent) === null || _this5$fireAnalyticsE2 === void 0 || _this5$fireAnalyticsE2.call(_this5, (0, _errorHandling.createErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId), undefined, _this5.getSourceLocation()));
         }).finally(function () {
           _this5.pendingCreationPromises.delete(resourceId);
         });
@@ -660,9 +662,15 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         (0, _error.logException)(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, (0, _errorHandling.createErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId)));
+        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, (0, _errorHandling.createErrorPayload)(error.message, resourceId, (0, _utils.getSourceProductFromResourceIdSafe)(resourceId), undefined, this.getSourceLocation()));
       }
     }
+  }, {
+    key: "getSourceLocation",
+    value: function getSourceLocation() {
+      var _this$dataProvider2, _this$dataProvider2$g;
+      return (0, _fieldAwareLocations.getSourceLocation)((_this$dataProvider2 = this.dataProvider) === null || _this$dataProvider2 === void 0 || (_this$dataProvider2$g = _this$dataProvider2.getParentAri) === null || _this$dataProvider2$g === void 0 ? void 0 : _this$dataProvider2$g.call(_this$dataProvider2));
+    }
   }, {
     key: "pruneRecentDeleteEmissions",
     value:

package/dist/cjs/utils/errorHandling.js

@@ -221,18 +221,20 @@ var buildFetchErrorAttribution = exports.buildFetchErrorAttribution = function b
  * buckets like `source_deleted` they never emit.
  */
 
-function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct, attribution) {
+function getErrorPayload(actionSubjectId, error, resourceId, sourceProduct, attribution, sourceLocation) {
   return {
     action: _enums.ACTION.ERROR,
     actionSubject: _enums.ACTION_SUBJECT.SYNCED_BLOCK,
     actionSubjectId: actionSubjectId,
     eventType: _enums.EVENT_TYPE.OPERATIONAL,
-    attributes: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
+    attributes: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
       error: error
     }, resourceId && {
       resourceId: resourceId
     }), sourceProduct && {
       sourceProduct: sourceProduct
+    }), sourceLocation && {
+      sourceLocation: sourceLocation
     }), (attribution === null || attribution === void 0 ? void 0 : attribution.reason) && {
       reason: attribution.reason
     }), (attribution === null || attribution === void 0 ? void 0 : attribution.statusCode) !== undefined && {
@@ -252,8 +254,8 @@ var fetchErrorPayload = exports.fetchErrorPayload = function fetchErrorPayload(e
     attribution ? getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error, resourceId, sourceProduct, attribution) : getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_FETCH, error, resourceId, sourceProduct)
   );
 };
-var getSourceInfoErrorPayload = exports.getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error, resourceId, sourceProduct) {
-  return getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId, sourceProduct);
+var getSourceInfoErrorPayload = exports.getSourceInfoErrorPayload = function getSourceInfoErrorPayload(error, resourceId, sourceProduct, sourceLocation) {
+  return getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_GET_SOURCE_INFO, error, resourceId, sourceProduct, undefined, sourceLocation);
 };
 var updateErrorPayload = exports.updateErrorPayload = function updateErrorPayload(error, resourceId, sourceProduct, attribution) {
   return getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
@@ -261,8 +263,8 @@ var updateErrorPayload = exports.updateErrorPayload = function updateErrorPayloa
 var updateReferenceErrorPayload = exports.updateReferenceErrorPayload = function updateReferenceErrorPayload(error, resourceId, sourceProduct, attribution) {
   return getErrorPayload(_enums.ACTION_SUBJECT_ID.REFERENCE_SYNCED_BLOCK_UPDATE, error, resourceId, sourceProduct, attribution);
 };
-var createErrorPayload = exports.createErrorPayload = function createErrorPayload(error, resourceId, sourceProduct, attribution) {
-  return getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct, attribution);
+var createErrorPayload = exports.createErrorPayload = function createErrorPayload(error, resourceId, sourceProduct, attribution, sourceLocation) {
+  return getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE, error, resourceId, sourceProduct, attribution, sourceLocation);
 };
 var deleteErrorPayload = exports.deleteErrorPayload = function deleteErrorPayload(error, resourceId, sourceProduct, attribution) {
   return getErrorPayload(_enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_DELETE, error, resourceId, sourceProduct, attribution);
@@ -331,16 +333,18 @@ var fetchSuccessPayload = exports.fetchSuccessPayload = function fetchSuccessPay
     })
   };
 };
-var createSuccessPayload = exports.createSuccessPayload = function createSuccessPayload(resourceId, sourceProduct) {
+var createSuccessPayload = exports.createSuccessPayload = function createSuccessPayload(resourceId, sourceProduct, sourceLocation) {
   return {
     action: _enums.ACTION.INSERTED,
     actionSubject: _enums.ACTION_SUBJECT.DOCUMENT,
     actionSubjectId: _enums.ACTION_SUBJECT_ID.BODIED_SYNCED_BLOCK,
     eventType: _enums.EVENT_TYPE.TRACK,
-    attributes: _objectSpread({
+    attributes: _objectSpread(_objectSpread({
       resourceId: resourceId
     }, sourceProduct && {
       sourceProduct: sourceProduct
+    }), sourceLocation && {
+      sourceLocation: sourceLocation
     })
   };
 };
@@ -357,14 +361,14 @@ var createSuccessPayload = exports.createSuccessPayload = function createSuccess
  * Operational `syncedBlockCreate` success event with the `blockInstanceId` join key and,
  * when available, the `inputMethod`, `createdEmpty`, and `nodeTypes` creation signals.
  */
-var createSuccessOperationalPayload = exports.createSuccessOperationalPayload = function createSuccessOperationalPayload(resourceId, blockInstanceId, sourceProduct, enrichment) {
+var createSuccessOperationalPayload = exports.createSuccessOperationalPayload = function createSuccessOperationalPayload(resourceId, blockInstanceId, sourceProduct, enrichment, sourceLocation) {
   var _enrichment$nodeTypes;
   return {
     action: _enums.ACTION.INSERTED,
     actionSubject: _enums.ACTION_SUBJECT.SYNCED_BLOCK,
     actionSubjectId: _enums.ACTION_SUBJECT_ID.SYNCED_BLOCK_CREATE,
     eventType: _enums.EVENT_TYPE.OPERATIONAL,
-    attributes: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
+    attributes: _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({
       resourceId: resourceId
     }, blockInstanceId && {
       blockInstanceId: blockInstanceId
@@ -376,6 +380,8 @@ var createSuccessOperationalPayload = exports.createSuccessOperationalPayload =
       createdEmpty: enrichment.createdEmpty
     }), (enrichment === null || enrichment === void 0 || (_enrichment$nodeTypes = enrichment.nodeTypes) === null || _enrichment$nodeTypes === void 0 ? void 0 : _enrichment$nodeTypes.length) && {
       nodeTypes: enrichment.nodeTypes
+    }), sourceLocation && {
+      sourceLocation: sourceLocation
     })
   };
 };

package/dist/cjs/utils/fieldAwareLocations.js

@@ -3,9 +3,11 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isFieldAwareJiraLocation = exports.getFieldAwareLocationScope = void 0;
+exports.isFieldAwareJiraLocation = exports.getSourceLocation = exports.getFieldAwareLocationScope = void 0;
 var _isExperimentEnabled = require("@atlaskit/platform-feature-experiments/is-experiment-enabled");
+var _fg = require("@atlaskit/platform-feature-flags/fg");
 var _ari = require("../clients/block-service/ari");
+var _ari2 = require("../clients/jira/ari");
 /**
  * The product check runs first so a Confluence-only document never reads the experiment.
  */
@@ -27,4 +29,27 @@ var getFieldAwareLocationScope = exports.getFieldAwareLocationScope = function g
       hostAri: hostAri
     })
   } : undefined;
+};
+
+/**
+ * Analytics `sourceLocation` for a source ARI: `undefined` for non-Jira sources and for the
+ * control cohort, so events outside the experiment keep their current shape.
+ *
+ * The `platform_editor_blocks_patch_13` gate runs first: with it off this returns `undefined`
+ * without the product check or the experiment read, so no new exposure is logged.
+ */
+var getSourceLocation = exports.getSourceLocation = function getSourceLocation(sourceAri) {
+  if (!(0, _fg.fg)('platform_editor_blocks_patch_13')) {
+    return undefined;
+  }
+  if (!sourceAri || !isFieldAwareJiraLocation((0, _ari.getProductFromSourceAri)(sourceAri))) {
+    return undefined;
+  }
+  var location = (0, _ari2.parseJiraFieldLocation)({
+    ari: sourceAri
+  });
+  if (!location) {
+    return undefined;
+  }
+  return location.fieldId === _ari2.JIRA_DESCRIPTION_FIELD_ID ? 'description' : 'custom-field';
 };

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

@@ -66,7 +66,7 @@ export const getJiraIssueAriFromSourceAri = ({
   }
   return ari;
 };
-const JIRA_DESCRIPTION_FIELD_ID = 'description';
+export const JIRA_DESCRIPTION_FIELD_ID = 'description';
 
 /**
  * One synced block location on a Jira work item, parsed once from its document ARI.

package/dist/es2019/common/types.js

@@ -5,6 +5,8 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
  * `same-parent-document` is another field of the host work item.
  */
 
+/** Which Jira work item field holds a source block. */
+
 export let SyncBlockError = /*#__PURE__*/function (SyncBlockError) {
   SyncBlockError["Errored"] = "errored";
   SyncBlockError["NotFound"] = "not_found";

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

@@ -414,10 +414,20 @@ export const writeDataBatch = async (cloudId, parentAri, parentId, product, data
 class BlockServiceADFFetchProvider {
   constructor({
     cloudId,
-    parentAri
+    parentAri,
+    parentId,
+    product
   }) {
     this.cloudId = cloudId;
     this.parentAri = parentAri;
+    this.parentId = parentId;
+    this.product = product;
+  }
+  generateResourceIdForReference(sourceId) {
+    if (!this.product || !this.parentId) {
+      return sourceId;
+    }
+    return createResourceIdForReference(this.product, this.parentId, sourceId);
   }
 
   // resourceId of the reference synced block.
@@ -975,7 +985,9 @@ const createBlockServiceAPIProviders = ({
   return {
     fetchProvider: new BlockServiceADFFetchProvider({
       cloudId,
-      parentAri
+      parentAri,
+      parentId,
+      product
     }),
     writeProvider: new BlockServiceADFWriteProvider({
       cloudId,
@@ -1005,12 +1017,16 @@ export const useMemoizedBlockServiceAPIProviders = ({
 };
 const createBlockServiceFetchOnlyAPIProvider = ({
   cloudId,
-  parentAri
+  parentAri,
+  parentId,
+  product
 }) => {
   return {
     fetchProvider: new BlockServiceADFFetchProvider({
       cloudId,
-      parentAri
+      parentAri,
+      parentId,
+      product
     }),
     writeProvider: undefined
   };
@@ -1021,8 +1037,12 @@ const createBlockServiceFetchOnlyAPIProvider = ({
  */
 export const useMemoizedBlockServiceFetchOnlyAPIProvider = ({
   cloudId,
-  parentAri
+  parentAri,
+  parentId,
+  product
 }) => useMemo(() => createBlockServiceFetchOnlyAPIProvider({
   cloudId,
-  parentAri
-}), [cloudId, parentAri]);
+  parentAri,
+  parentId,
+  product
+}), [cloudId, parentAri, parentId, product]);

package/dist/es2019/providers/syncBlockProvider.js

@@ -1,5 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import { useMemo, useRef } from 'react';
+import { isExperimentEnabled } from '@atlaskit/platform-feature-experiments/is-experiment-enabled';
 import { getProductFromSourceAri } from '../clients/block-service/ari';
 import { getPageIdAndTypeFromConfluencePageAri } from '../clients/confluence/ari';
 import { fetchConfluencePageInfo } from '../clients/confluence/sourceInfo';
@@ -244,6 +245,10 @@ export class SyncedBlockProvider extends SyncBlockDataProviderInterface {
         return Promise.reject(new Error(`${product} source product not supported`));
     }
   }
+  getParentAri() {
+    var _this$writeProvider6;
+    return (_this$writeProvider6 = this.writeProvider) === null || _this$writeProvider6 === void 0 ? void 0 : _this$writeProvider6.parentAri;
+  }
   generateResourceId() {
     const localId = crypto.randomUUID();
     const resourceId = crypto.randomUUID();
@@ -252,10 +257,11 @@ export class SyncedBlockProvider extends SyncBlockDataProviderInterface {
       resourceId
     };
   }
-  canGenerateResourceIdForReference() {
-    return this.writeProvider !== undefined;
-  }
   generateResourceIdForReference(sourceId) {
+    if (isExperimentEnabled('platform_editor_blocks_patch_12')) {
+      var _this$fetchProvider$g, _this$fetchProvider$g2, _this$fetchProvider;
+      return (_this$fetchProvider$g = (_this$fetchProvider$g2 = (_this$fetchProvider = this.fetchProvider).generateResourceIdForReference) === null || _this$fetchProvider$g2 === void 0 ? void 0 : _this$fetchProvider$g2.call(_this$fetchProvider, sourceId)) !== null && _this$fetchProvider$g !== void 0 ? _this$fetchProvider$g : sourceId;
+    }
     if (!this.writeProvider) {
       throw new Error('Write provider not set');
     }