@atlaskit/editor-synced-block-provider 8.5.7 → 8.6.1

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

@@ -12,7 +12,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
 import { logException } from '@atlaskit/editor-common/monitoring';
 import { fg } from '@atlaskit/platform-feature-flags';
 import { SyncBlockError } from '../common/types';
-import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, createSuccessOperationalPayload, deleteSuccessPayload, fetchReferencesErrorPayload, buildErrorAttribution } from '../utils/errorHandling';
+import { updateErrorPayload, createErrorPayload, deleteErrorPayload, updateCacheErrorPayload, getSourceInfoErrorPayload, updateSuccessPayload, createSuccessPayload, createSuccessOperationalPayload, addContentSuccessPayload, deleteSuccessPayload, fetchReferencesErrorPayload, buildErrorAttribution } from '../utils/errorHandling';
 import { getCreateSourceExperience, getDeleteSourceExperience, getSaveSourceExperience, getFetchSourceInfoExperience } from '../utils/experienceTracking';
 import { convertSyncBlockPMNodeToSyncBlockData, getSourceProductFromResourceIdSafe } from '../utils/utils';
 /** Maximum time (ms) flush() will wait for in-flight block creations before proceeding. */
@@ -52,6 +52,20 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
      * multiple blocks are created concurrently. See EDITOR-7112.
      */
     _defineProperty(this, "creationsTimedOutDuringFlush", new Set());
+    /**
+     * Creation-type signals captured at `createBodiedSyncBlockNode` time and read
+     * back in `commitPendingCreation` to enrich the `syncedBlockCreate` event.
+     * Kept out of the flushed cache record so it never leaks into Block Service /
+     * ADF; removed once consumed.
+     */
+    _defineProperty(this, "creationEnrichment", new Map());
+    /**
+     * Resource IDs of blocks created empty this session that have not yet fired
+     * the first-content-added event. Added on empty creation, removed when the
+     * block first gains content (the event fires once). Blocks created with
+     * content or not created this session are never tracked.
+     */
+    _defineProperty(this, "awaitingFirstContent", new Set());
     /**
      * resourceId -> timestamp (ms) of the last `syncedBlockDelete` emission, used
      * to suppress duplicates within {@link DELETE_DEDUPE_WINDOW_MS}. Only consulted
@@ -404,17 +418,48 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         var _this$fireAnalyticsEv4;
         var sourceProduct = getSourceProductFromResourceIdSafe(resourceId);
         (_this$fireAnalyticsEv4 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv4 === void 0 || _this$fireAnalyticsEv4.call(this, createSuccessPayload(resourceId || '', sourceProduct));
-        // Operational create-success event with the join key.
+        // Operational create-success event with the join key + creation-type
+        // signals (inputMethod / createdEmpty) captured at the command layer.
         if (fg('platform_editor_blocks_patch_4')) {
           var _this$fireAnalyticsEv5, _this$syncBlockCache$;
-          (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, createSuccessOperationalPayload(resourceId || '', (_this$syncBlockCache$ = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$ === void 0 ? void 0 : _this$syncBlockCache$.blockInstanceId, sourceProduct));
+          (_this$fireAnalyticsEv5 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv5 === void 0 || _this$fireAnalyticsEv5.call(this, createSuccessOperationalPayload(resourceId || '', (_this$syncBlockCache$ = this.syncBlockCache.get(resourceId)) === null || _this$syncBlockCache$ === void 0 ? void 0 : _this$syncBlockCache$.blockInstanceId, sourceProduct, this.creationEnrichment.get(resourceId)));
         }
       } else {
         var _this$fireAnalyticsEv6;
         // Delete the node from cache if fail to create so it's not flushed to BE
         this.syncBlockCache.delete(resourceId || '');
+        // 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, createErrorPayload('Fail to create bodied sync block', resourceId, getSourceProductFromResourceIdSafe(resourceId)));
       }
+      // Enrichment is single-use — drop it once the create has resolved either way.
+      this.creationEnrichment.delete(resourceId || '');
+    }
+
+    /**
+     * Fire the first-content-added event once when a block created empty this
+     * session first gains content. The caller detects the in-block edit; this owns
+     * dedupe + emission (fires at most once per block, only for empty→content).
+     * Gated behind `platform_editor_blocks_patch_4`.
+     */
+  }, {
+    key: "maybeEmitFirstContentAdded",
+    value: function maybeEmitFirstContentAdded(resourceId, blockInstanceId) {
+      var _this$fireAnalyticsEv7;
+      if (this.viewMode === 'view') {
+        return;
+      }
+      if (!fg('platform_editor_blocks_patch_4')) {
+        return;
+      }
+      // `delete` returns false when the id was not tracked (already emitted, or
+      // the block was not created empty this session), so this both dedupes and
+      // scopes emission to genuine first-content transitions in one check.
+      if (!this.awaitingFirstContent.delete(resourceId)) {
+        return;
+      }
+      (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, addContentSuccessPayload(resourceId, blockInstanceId, getSourceProductFromResourceIdSafe(resourceId)));
     }
   }, {
     key: "registerConfirmationCallback",
@@ -454,16 +499,28 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
      * @param attrs attributes Ids of the node
      * @param node the ProseMirror node to cache
      * @param onCompletion callback invoked when creation completes
+     * @param enrichment optional creation-type signals stashed and attached to the
+     *   `syncedBlockCreate` event when the async create resolves. When
+     *   `createdEmpty` is true the block is also registered for the
+     *   first-content-added event.
      */
   }, {
     key: "createBodiedSyncBlockNode",
-    value: function createBodiedSyncBlockNode(attrs, node, onCompletion) {
+    value: function createBodiedSyncBlockNode(attrs, node, onCompletion, enrichment) {
       var _this4 = this;
       if (this.viewMode === 'view') {
         return;
       }
       var resourceId = attrs.resourceId,
         blockInstanceId = attrs.localId;
+      // Stash creation-type signals for commitPendingCreation to read.
+      if (enrichment) {
+        this.creationEnrichment.set(resourceId, enrichment);
+        // Only empty-created blocks can produce an empty→content transition.
+        if (enrichment.createdEmpty) {
+          this.awaitingFirstContent.add(resourceId);
+        }
+      }
       try {
         var _this$createExperienc;
         if (!this.dataProvider) {
@@ -513,14 +570,14 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         });
         this.pendingCreationPromises.set(resourceId, creationPromise);
       } catch (error) {
-        var _this$fireAnalyticsEv7;
+        var _this$fireAnalyticsEv8;
         if (this.isPendingCreation(resourceId)) {
           this.commitPendingCreation(false, resourceId);
         }
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv7 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv7 === void 0 || _this$fireAnalyticsEv7.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, createErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
       }
     }
   }, {
@@ -558,11 +615,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
   }, {
     key: "emitDeleteSuccess",
     value: function emitDeleteSuccess(resourceId, reason, mechanism) {
-      var _this$syncBlockCache$2, _this$fireAnalyticsEv9;
+      var _this$syncBlockCache$2, _this$fireAnalyticsEv0;
       var sourceProduct = getSourceProductFromResourceIdSafe(resourceId);
       if (!fg('platform_editor_blocks_patch_4')) {
-        var _this$fireAnalyticsEv8;
-        (_this$fireAnalyticsEv8 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv8 === void 0 || _this$fireAnalyticsEv8.call(this, deleteSuccessPayload(resourceId, sourceProduct));
+        var _this$fireAnalyticsEv9;
+        (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, deleteSuccessPayload(resourceId, sourceProduct));
         return;
       }
       var now = Date.now();
@@ -577,7 +634,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         deletionReason: reason,
         mechanism: mechanism
       };
-      (_this$fireAnalyticsEv9 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv9 === void 0 || _this$fireAnalyticsEv9.call(this, deleteSuccessPayload(resourceId, sourceProduct, enrichment));
+      (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 || _this$fireAnalyticsEv0.call(this, deleteSuccessPayload(resourceId, sourceProduct, enrichment));
     }
   }, {
     key: "delete",
@@ -926,11 +983,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
           return sourceInfo;
         });
       } catch (error) {
-        var _this$fireAnalyticsEv0;
+        var _this$fireAnalyticsEv1;
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv0 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv0 === void 0 || _this$fireAnalyticsEv0.call(this, getSourceInfoErrorPayload(error.message));
+        (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 || _this$fireAnalyticsEv1.call(this, getSourceInfoErrorPayload(error.message));
         return Promise.resolve(undefined);
       }
     }
@@ -943,11 +1000,11 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         }
         return this.dataProvider.fetchReferences(resourceId, true);
       } catch (error) {
-        var _this$fireAnalyticsEv1;
+        var _this$fireAnalyticsEv10;
         logException(error, {
           location: 'editor-synced-block-provider/sourceSyncBlockStoreManager'
         });
-        (_this$fireAnalyticsEv1 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv1 === void 0 || _this$fireAnalyticsEv1.call(this, fetchReferencesErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
+        (_this$fireAnalyticsEv10 = this.fireAnalyticsEvent) === null || _this$fireAnalyticsEv10 === void 0 || _this$fireAnalyticsEv10.call(this, fetchReferencesErrorPayload(error.message, resourceId, getSourceProductFromResourceIdSafe(resourceId)));
         return Promise.resolve({
           error: SyncBlockError.Errored
         });
@@ -964,6 +1021,8 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
       this.postCreationFlushCallback = undefined;
       this.pendingCreationPromises.clear();
       this.creationsTimedOutDuringFlush.clear();
+      this.creationEnrichment.clear();
+      this.awaitingFirstContent.clear();
       this.recentDeleteEmissions.clear();
       this.dataProvider = undefined;
       (_this$saveExperience4 = this.saveExperience) === null || _this$saveExperience4 === void 0 || _this$saveExperience4.abort({