@atlaskit/editor-synced-block-provider 12.0.7 → 12.1.1

package/dist/types/providers/types.d.ts

@@ -5,17 +5,17 @@ import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
 import type { SyncBlockData, SyncBlockStatus, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData, DeletionReason } from '../common/types';
 type SyncBlockErrorInfo = {
-    /**
-     * PII-safe `Error.name` from the upstream catch, used to de-opaque `errored`
-     * failures. Only ever `Error.name` — never node content, titles, or any UGC.
-     */
-    originalName?: string;
     /**
      * PII-safe `Error.message` from the upstream catch, so the classifier can bucket
      * the real cause. Distinct from `reason` (may be synthetic/enum): carries the raw
      * framework/HTTP text. Only ever `Error.message` — never node content or UGC.
      */
     originalMessage?: string;
+    /**
+     * PII-safe `Error.name` from the upstream catch, used to de-opaque `errored`
+     * failures. Only ever `Error.name` — never node content, titles, or any UGC.
+     */
+    originalName?: string;
     reason?: string;
     sourceAri?: string;
     /**
@@ -28,6 +28,10 @@ type SyncBlockErrorInfo = {
     statusCode?: number;
     type: SyncBlockError;
 };
+type LocalSameDocumentSourceProvenance = Readonly<{
+    sourceBlockInstanceId: BlockInstanceId;
+    sourceProduct: SyncBlockProduct;
+}>;
 /**
  * The instance of a sync block, containing its data and metadata.
  * Mainly used for representing the state of a sync block after fetching from a data provider.
@@ -36,6 +40,11 @@ type SyncBlockErrorInfo = {
 export type SyncBlockInstance = {
     data?: SyncBlockData;
     error?: SyncBlockErrorInfo;
+    /**
+     * In-memory-only proof that this instance was projected from a source in the
+     * current document. Publication status lives on `data.status`.
+     */
+    localSameDocumentSource?: LocalSameDocumentSourceProvenance;
     /**
      *  The resourceId in the attrs of the block
      */

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

@@ -5,9 +5,11 @@ import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { BlockInstanceId, ResourceId, SyncBlockNode, SyncBlockPrefetchData } from '../common/types';
 import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProviderInterface, TitleSubscriptionCallback, SyncBlockSourceInfo, SyncedBlockRendererProviderOptions } from '../providers/types';
+import type { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 export declare class ReferenceSyncBlockStoreManager {
     private viewMode?;
     private dataProvider?;
+    private sourceManager?;
     private isCacheDirty;
     private fireAnalyticsEvent?;
     private syncBlockFetchDataRequests;
@@ -29,7 +31,7 @@ export declare class ReferenceSyncBlockStoreManager {
     private _subscriptionManager;
     private _providerFactoryManager;
     private _batchFetcher;
-    constructor(dataProvider?: SyncBlockDataProviderInterface, viewMode?: ViewMode);
+    constructor(dataProvider?: SyncBlockDataProviderInterface, viewMode?: ViewMode, sourceManager?: SourceSyncBlockStoreManager);
     isReferenceBlock(node: PMNode): boolean;
     /**
      * Whether the async data provider is wired and the manager is not torn down.
@@ -78,6 +80,8 @@ export declare class ReferenceSyncBlockStoreManager {
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;
+    private getSameDocumentReferenceParts;
+    private getLocalReference;
     private normalizeReferenceData;
     private updateSessionCache;
     private getFromSessionCache;

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

@@ -1,19 +1,26 @@
+import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import type { ViewMode } from '@atlaskit/editor-plugin-editor-viewmode';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { ResourceId, SyncBlockAttrs, BlockInstanceId, DeletionReason, DeletionMechanism, ReferenceSyncBlockData, SyncBlockStatus } from '../common/types';
+import type { ResourceId, SyncBlockAttrs, SyncBlockData as Data, BlockInstanceId, DeletionReason, DeletionMechanism, ReferenceSyncBlockData, SyncBlockStatus } from '../common/types';
 import type { SyncBlockDataProviderInterface, SyncBlockSourceInfo } from '../providers/types';
 import type { CreateSuccessEnrichment } from '../utils/errorHandling';
 export type ConfirmationCallback = (syncBlockIds: SyncBlockAttrs[], deleteReason: DeletionReason | undefined) => Promise<boolean>;
 type OnDelete = () => void;
 type OnCompletion = (success: boolean) => void;
 type DestroyCallback = () => void;
+export type LocalSourceSnapshot = Readonly<Omit<Data, 'content' | 'status'> & {
+    content: ReadonlyArray<ADFEntity>;
+    status?: SyncBlockStatus;
+}>;
+export type LocalSourceSubscriber = (snapshot: LocalSourceSnapshot | undefined) => void;
 export declare class SourceSyncBlockStoreManager {
     private viewMode?;
     private isLivePage?;
     private dataProvider?;
     private fireAnalyticsEvent?;
     private syncBlockCache;
+    private localSourceSubscribers;
     private hasReceivedContentChange;
     private confirmationCallback?;
     private deletionRetryInfo?;
@@ -106,6 +113,9 @@ export declare class SourceSyncBlockStoreManager {
     hasPendingCreations(): boolean;
     /** Returns the source block's last known backend publication status. */
     getStatus(resourceId: ResourceId): SyncBlockStatus | undefined;
+    getLocalSourceSnapshot(resourceId: ResourceId): LocalSourceSnapshot | undefined;
+    subscribeToLocalSource(resourceId: ResourceId, callback: LocalSourceSubscriber): () => void;
+    private notifyLocalSource;
     /**
      *  Fires callback to insert node (if creation is successful) and clears pending creation data
      * @param success

package/package.json

@@ -16,13 +16,14 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-utils": "^20.7.0",
+		"@atlaskit/adf-utils": "^20.8.0",
 		"@atlaskit/browser-apis": "^1.2.0",
-		"@atlaskit/editor-json-transformer": "^9.7.0",
+		"@atlaskit/editor-json-transformer": "^9.8.0",
 		"@atlaskit/editor-prosemirror": "^8.0.0",
 		"@atlaskit/node-data-provider": "^17.0.0",
-		"@atlaskit/platform-feature-flags": "^2.1.0",
-		"@atlaskit/tmp-editor-statsig": "^167.0.0",
+		"@atlaskit/platform-feature-experiments": "^0.3.0",
+		"@atlaskit/platform-feature-flags": "^2.2.0",
+		"@atlaskit/tmp-editor-statsig": "^169.0.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^1.0.2",
 		"bind-event-listener": "^3.0.0",
@@ -32,7 +33,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.7.0",
+		"@atlaskit/editor-common": "^120.10.0",
 		"react": "^18.2.0 || ^19.2.0"
 	},
 	"devDependencies": {
@@ -76,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "12.0.7",
+	"version": "12.1.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",