@atlaskit/editor-synced-block-provider 8.6.12 → 8.6.14

package/AGENTS.md

@@ -4,7 +4,7 @@
 >
 > **For workflow guidance, debugging, and cross-package task guides, load the `synced-blocks`
 > skill:**
-> `get_skill(skill_name_or_path="platform/packages/editor/.rovodev/skills/synced-blocks/SKILL.md")`
+> `get_skill(skill_name_or_path="platform/packages/editor/.agents/skills/synced-blocks/SKILL.md")`
 
 ---
 
@@ -22,10 +22,16 @@ plugin and the renderer across Confluence and Jira.
 src/
 ├── index.ts                          # Barrel export
 ├── store-manager/
-│   ├── syncBlockStoreManager.ts      # Parent coordinator for source + reference managers
-│   ├── referenceSyncBlockStoreManager.ts # Reference block lifecycle, cache, subscriptions, flush
-│   └── sourceSyncBlockStoreManager.ts    # Source block create, update, delete, flush,
-│                                           hasPendingCreations(), discardUnpublishedBlocks()
+│   ├── syncBlockStoreManager.ts          # Facade: delegates to source + reference managers
+│   ├── sourceSyncBlockStoreManager.ts    # Source lifecycle: updateSyncBlockData, flush,
+│   │                                       hasUnsavedChanges(), hasPendingCreations(),
+│   │                                       commitPendingCreation(), discardUnpublishedBlocks(),
+│   │                                       deleteSyncBlocksWithConfirmation()
+│   ├── referenceSyncBlockStoreManager.ts # Reference lifecycle: fetch, cache, subscriptions, flush
+│   ├── syncBlockBatchFetcher.ts          # Debounced/deduped batch fetch of reference data
+│   ├── syncBlockInMemorySessionCache.ts  # Session cache (survives view↔edit within a session)
+│   ├── syncBlockSubscriptionManager.ts   # Real-time subscription registry (AGG/Relay)
+│   └── syncBlockProviderFactoryManager.ts # Builds/wires the provider instances
 ├── clients/
 │   ├── block-service/
 │   │   ├── blockService.ts           # Block service API client (fetch, batch, CRUD)
@@ -43,7 +49,7 @@ src/
 │   ├── useFetchSyncBlockTitle.ts     # React hook: fetch source title/url metadata
 │   └── useHandleContentChanges.ts    # Wires editor content changes into source manager
 ├── common/
-│   ├── consts.ts                     # Shared constants (debounce timings, etc.)
+│   ├── consts.ts                     # Shared constants (e.g. SYNC_BLOCK_PRODUCTS)
 │   ├── rebase-transaction.ts         # Shared transaction rebase helpers
 │   └── types.ts                      # Cross-module types
 ├── utils/
@@ -64,19 +70,23 @@ src/
 ### Store Manager Hierarchy
 
 ```
-SyncBlockStoreManager (parent coordinator)
-├── SourceSyncBlockStoreManager
-│   ├── create(content) → Block Service API → returns resourceId
-│   ├── updateSyncBlockData(node) → marks isDirty, caches content
-│   ├── flush() → persist all dirty changes to backend
-│   ├── hasUnsavedChanges() → checks isDirty + hasReceivedContentChange
-│   ├── hasPendingCreations() → O(1) pending-creation check (EDITOR-6930)
-│   ├── discardUnpublishedBlocks() → delete unpublished blocks (EDITOR-6473)
-│   └── delete(resourceId) → soft delete with confirmation
-└── ReferenceSyncBlockStoreManager
+SyncBlockStoreManager (facade — delegates to source + reference managers)
+├── sourceManager: SourceSyncBlockStoreManager
+│   ├── updateSyncBlockData(node) → marks isDirty + hasReceivedContentChange, caches content
+│   ├── flush() → persist all dirty source changes to Block Service
+│   ├── hasUnsavedChanges() → hasReceivedContentChange && any block isDirty
+│   ├── hasPendingCreations() / isPendingCreation(id) → O(1) pending-creation checks (EDITOR-6930)
+│   ├── commitPendingCreation(...) → reconcile a pending source after it persists
+│   ├── createBodiedSyncBlockNode(...) / generateBodiedSyncBlockAttrs() → build a new source node
+│   ├── discardUnpublishedBlocks() → drop never-published sources (EDITOR-6473)
+│   ├── deleteSyncBlocksWithConfirmation() → confirmed source deletion (+ retryDeletion())
+│   ├── registerConfirmationCallback() / setFireAnalyticsEvent() → product-supplied hooks
+│   └── (no create()/delete(): sources are created lazily then flushed — see the skill)
+└── referenceManager: ReferenceSyncBlockStoreManager
     ├── fetchSyncBlocksData(nodes) → batch fetch with deduplication
-    ├── subscribeToSyncBlock(resourceId, callback) → AGG WebSocket
+    ├── subscribeToSyncBlock(resourceId, callback) → AGG WebSocket / Relay
     ├── fetchSyncBlockSourceInfo(resourceId) → title, URL metadata
+    ├── flush() → flush reference-side pending work
     └── destroy() → cleanup subscriptions and batchers
 ```
 
@@ -92,7 +102,10 @@ SyncBlockStoreManager (parent coordinator)
 ### Block Service API
 
 The client in `clients/block-service/blockService.ts` communicates via GraphQL at
-`/gateway/api/graphql`: Fetch, Create, Update (debounced 3s), Delete, Source Info, References Info.
+`/gateway/api/graphql`: Fetch, Create, Update, Delete, Source Info, References Info. The GraphQL
+mutations are **not** debounced at the client — write batching is driven by the product layer
+calling `flush()` (Confluence draft-sync/publish, Jira save). Reference reads are batched/deduped
+via `syncBlockBatchFetcher.ts`. Grep for the current timing constants rather than assuming a value.
 
 ### Media Token Fetching
 

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-synced-block-provider
 
+## 8.6.14
+
+### Patch Changes
+
+- [`1207d5bc1e287`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/1207d5bc1e287) -
+  Show zero synced locations immediately for newly inserted source blocks
+- Updated dependencies
+
+## 8.6.13
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 8.6.12
 
 ### Patch Changes

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

@@ -66,6 +66,13 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
      * ADF; removed once consumed.
      */
     (0, _defineProperty2.default)(this, "creationEnrichment", new Map());
+    /**
+     * Source blocks created by the local insert command in this editor session that
+     * have not yet been reconciled with authoritative reference data. This state is
+     * intentionally kept out of ADF and the backend cache so reloaded, restored,
+     * copied, and remotely inserted sources cannot inherit it.
+     */
+    (0, _defineProperty2.default)(this, "newSourceBlockResourceIds", new Set());
     /**
      * 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
@@ -131,6 +138,16 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
     value: function isSourceBlock(node) {
       return node.type.name === 'bodiedSyncBlock';
     }
+  }, {
+    key: "isNewSourceBlock",
+    value: function isNewSourceBlock(resourceId) {
+      return this.newSourceBlockResourceIds.has(resourceId);
+    }
+  }, {
+    key: "clearNewSourceBlock",
+    value: function clearNewSourceBlock(resourceId) {
+      this.newSourceBlockResourceIds.delete(resourceId);
+    }
 
     /**
      * Add/update a sync block node to/from the local cache
@@ -443,6 +460,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         var _this$fireAnalyticsEv6;
         // Delete the node from cache if fail to create so it's not flushed to BE
         this.syncBlockCache.delete(resourceId || '');
+        this.newSourceBlockResourceIds.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 || '');
@@ -541,6 +559,9 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         if (!this.dataProvider) {
           throw new Error('Data provider not set');
         }
+        if (enrichment) {
+          this.newSourceBlockResourceIds.add(resourceId);
+        }
 
         // add the node to the cache
         this.updateSyncBlockData(node, false);
@@ -586,6 +607,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
         this.pendingCreationPromises.set(resourceId, creationPromise);
       } catch (error) {
         var _this$fireAnalyticsEv8;
+        this.newSourceBlockResourceIds.delete(resourceId);
         if (this.isPendingCreation(resourceId)) {
           this.commitPendingCreation(false, resourceId);
         }
@@ -1037,6 +1059,7 @@ var SourceSyncBlockStoreManager = exports.SourceSyncBlockStoreManager = /*#__PUR
       this.pendingCreationPromises.clear();
       this.creationsTimedOutDuringFlush.clear();
       this.creationEnrichment.clear();
+      this.newSourceBlockResourceIds.clear();
       this.awaitingFirstContent.clear();
       this.recentDeleteEmissions.clear();
       this.dataProvider = undefined;

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

@@ -47,6 +47,13 @@ export class SourceSyncBlockStoreManager {
      * ADF; removed once consumed.
      */
     _defineProperty(this, "creationEnrichment", new Map());
+    /**
+     * Source blocks created by the local insert command in this editor session that
+     * have not yet been reconciled with authoritative reference data. This state is
+     * intentionally kept out of ADF and the backend cache so reloaded, restored,
+     * copied, and remotely inserted sources cannot inherit it.
+     */
+    _defineProperty(this, "newSourceBlockResourceIds", new Set());
     /**
      * 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
@@ -104,6 +111,12 @@ export class SourceSyncBlockStoreManager {
   isSourceBlock(node) {
     return node.type.name === 'bodiedSyncBlock';
   }
+  isNewSourceBlock(resourceId) {
+    return this.newSourceBlockResourceIds.has(resourceId);
+  }
+  clearNewSourceBlock(resourceId) {
+    this.newSourceBlockResourceIds.delete(resourceId);
+  }
 
   /**
    * Add/update a sync block node to/from the local cache
@@ -368,6 +381,7 @@ export class SourceSyncBlockStoreManager {
       var _this$fireAnalyticsEv8;
       // Delete the node from cache if fail to create so it's not flushed to BE
       this.syncBlockCache.delete(resourceId || '');
+      this.newSourceBlockResourceIds.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 || '');
@@ -457,6 +471,9 @@ export class SourceSyncBlockStoreManager {
       if (!this.dataProvider) {
         throw new Error('Data provider not set');
       }
+      if (enrichment) {
+        this.newSourceBlockResourceIds.add(resourceId);
+      }
 
       // add the node to the cache
       this.updateSyncBlockData(node, false);
@@ -502,6 +519,7 @@ export class SourceSyncBlockStoreManager {
       this.pendingCreationPromises.set(resourceId, creationPromise);
     } catch (error) {
       var _this$fireAnalyticsEv10;
+      this.newSourceBlockResourceIds.delete(resourceId);
       if (this.isPendingCreation(resourceId)) {
         this.commitPendingCreation(false, resourceId);
       }
@@ -799,6 +817,7 @@ export class SourceSyncBlockStoreManager {
     this.pendingCreationPromises.clear();
     this.creationsTimedOutDuringFlush.clear();
     this.creationEnrichment.clear();
+    this.newSourceBlockResourceIds.clear();
     this.awaitingFirstContent.clear();
     this.recentDeleteEmissions.clear();
     this.dataProvider = undefined;

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

@@ -59,6 +59,13 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
      * ADF; removed once consumed.
      */
     _defineProperty(this, "creationEnrichment", new Map());
+    /**
+     * Source blocks created by the local insert command in this editor session that
+     * have not yet been reconciled with authoritative reference data. This state is
+     * intentionally kept out of ADF and the backend cache so reloaded, restored,
+     * copied, and remotely inserted sources cannot inherit it.
+     */
+    _defineProperty(this, "newSourceBlockResourceIds", new Set());
     /**
      * 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
@@ -124,6 +131,16 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
     value: function isSourceBlock(node) {
       return node.type.name === 'bodiedSyncBlock';
     }
+  }, {
+    key: "isNewSourceBlock",
+    value: function isNewSourceBlock(resourceId) {
+      return this.newSourceBlockResourceIds.has(resourceId);
+    }
+  }, {
+    key: "clearNewSourceBlock",
+    value: function clearNewSourceBlock(resourceId) {
+      this.newSourceBlockResourceIds.delete(resourceId);
+    }
 
     /**
      * Add/update a sync block node to/from the local cache
@@ -436,6 +453,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         var _this$fireAnalyticsEv6;
         // Delete the node from cache if fail to create so it's not flushed to BE
         this.syncBlockCache.delete(resourceId || '');
+        this.newSourceBlockResourceIds.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 || '');
@@ -534,6 +552,9 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         if (!this.dataProvider) {
           throw new Error('Data provider not set');
         }
+        if (enrichment) {
+          this.newSourceBlockResourceIds.add(resourceId);
+        }
 
         // add the node to the cache
         this.updateSyncBlockData(node, false);
@@ -579,6 +600,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
         this.pendingCreationPromises.set(resourceId, creationPromise);
       } catch (error) {
         var _this$fireAnalyticsEv8;
+        this.newSourceBlockResourceIds.delete(resourceId);
         if (this.isPendingCreation(resourceId)) {
           this.commitPendingCreation(false, resourceId);
         }
@@ -1030,6 +1052,7 @@ export var SourceSyncBlockStoreManager = /*#__PURE__*/function () {
       this.pendingCreationPromises.clear();
       this.creationsTimedOutDuringFlush.clear();
       this.creationEnrichment.clear();
+      this.newSourceBlockResourceIds.clear();
       this.awaitingFirstContent.clear();
       this.recentDeleteEmissions.clear();
       this.dataProvider = undefined;

package/dist/types/common/consts.d.ts

@@ -1 +1 @@
-export declare const SYNC_BLOCK_PRODUCTS: readonly ["confluence-page", "jira-work-item"];
+export declare const SYNC_BLOCK_PRODUCTS: readonly ['confluence-page', 'jira-work-item'];

package/dist/types/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -43,6 +43,13 @@ export declare class SourceSyncBlockStoreManager {
      * ADF; removed once consumed.
      */
     private creationEnrichment;
+    /**
+     * Source blocks created by the local insert command in this editor session that
+     * have not yet been reconciled with authoritative reference data. This state is
+     * intentionally kept out of ADF and the backend cache so reloaded, restored,
+     * copied, and remotely inserted sources cannot inherit it.
+     */
+    private newSourceBlockResourceIds;
     /**
      * 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
@@ -76,6 +83,8 @@ export declare class SourceSyncBlockStoreManager {
     registerPostCreationFlushCallback(callback: () => void): void;
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
     isSourceBlock(node: PMNode): boolean;
+    isNewSourceBlock(resourceId: ResourceId): boolean;
+    clearNewSourceBlock(resourceId: ResourceId): void;
     /**
      * Add/update a sync block node to/from the local cache
      * @param syncBlockNode - The sync block node to update

package/package.json

@@ -22,7 +22,7 @@
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/node-data-provider": "^13.0.0",
 		"@atlaskit/platform-feature-flags": "^2.1.0",
-		"@atlaskit/tmp-editor-statsig": "^134.0.0",
+		"@atlaskit/tmp-editor-statsig": "^135.6.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.0",
 		"bind-event-listener": "^3.0.0",
@@ -32,7 +32,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^116.40.0",
+		"@atlaskit/editor-common": "^116.44.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -76,7 +76,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "8.6.12",
+	"version": "8.6.14",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",