@atlaskit/editor-synced-block-provider 3.11.0 → 3.12.1

package/dist/types/clients/block-service/blockService.d.ts

@@ -92,14 +92,14 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
     documentAri: string;
     noContent?: boolean;
 };
-type BlockIdentifier = {
-    blockAri: string;
-    blockInstanceId: string;
-};
 export type BatchRetrieveSyncedBlocksRequest = {
     blockIdentifiers: BlockIdentifier[];
     documentAri: string;
 };
+type BlockIdentifier = {
+    blockAri: string;
+    blockInstanceId: string;
+};
 export type BatchRetrieveSyncedBlocksResponse = {
     error?: Array<ErrorResponse>;
     success?: Array<BlockContentResponse>;
@@ -116,7 +116,7 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
-export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const getSyncedBlockContent: ({ blockAri, documentAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
  *

package/dist/types/providers/block-service/blockServiceAPI.d.ts

@@ -40,7 +40,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     private extractResourceIdFromBlockAri;
     /**
      * Batch fetches multiple synced blocks by their resource IDs.
-     * @param blockNodeIdentifiers - Array of block node identifiers, containing block instance (local) ID + resource IDs to fetch
+     * @param resourceIds - Array of resource IDs to fetch
      * @returns Array of SyncBlockInstance results
      */
     batchFetchData(blockNodeIdentifiers: BlockNodeIdentifiers[]): Promise<SyncBlockInstance[]>;

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

@@ -5,6 +5,10 @@ import type { MentionProvider } from '@atlaskit/mention/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData } from '../common/types';
+export type BlockNodeIdentifiers = {
+    blockInstanceId: string;
+    resourceId: string;
+};
 /**
  * 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.
@@ -52,10 +56,6 @@ export type UpdateReferenceSyncBlockResult = {
     error?: string;
     success: boolean;
 };
-export type BlockNodeIdentifiers = {
-    blockInstanceId: string;
-    resourceId: string;
-};
 export interface ADFFetchProvider {
     batchFetchData: (blockNodeIdentifiers: BlockNodeIdentifiers[]) => Promise<SyncBlockInstance[]>;
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
@@ -88,8 +88,8 @@ export type SyncedBlockRendererDataProviders = {
 export type SyncBlockRendererProviderCreator = {
     createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider> | undefined) | undefined;
     createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider> | undefined) | undefined;
-    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
     createSSRMediaProvider?: ((options: MediaEmojiProviderOptions) => MediaProvider | undefined) | undefined;
+    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
 };
 export type SyncedBlockRendererProviderOptions = {
     parentDataProviders?: SyncedBlockRendererDataProviders;

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

@@ -22,7 +22,6 @@ export declare class ReferenceSyncBlockStoreManager {
     private saveExperience;
     constructor(dataProvider?: SyncBlockDataProvider);
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
-    setExperiences(fetchExperience: Experience, fetchSourceInfoExperience: Experience, saveExperience: Experience): void;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;

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

@@ -1,5 +1,4 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-import type { Experience } from '@atlaskit/editor-common/experiences';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockAttrs, type BlockInstanceId } from '../common/types';
 import type { SyncBlockDataProvider, SyncBlockSourceInfo } from '../providers/types';
@@ -16,14 +15,11 @@ export declare class SourceSyncBlockStoreManager {
     private deletionRetryInfo?;
     private pendingResourceId?;
     private creationCallback?;
-    createExperience: Experience | undefined;
+    private createExperience;
     private saveExperience;
     private deleteExperience;
     constructor(dataProvider?: SyncBlockDataProvider);
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
-    setCreateExperience(createExperience: Experience): void;
-    setSaveExperience(saveExperience: Experience): void;
-    setDeleteExperience(deleteExperience: Experience): void;
     isSourceBlock(node: PMNode): boolean;
     /**
      * Add/update a sync block node to/from the local cache

package/dist/types/utils/errorHandling.d.ts

@@ -1,13 +1,18 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, type RendererSyncBlockEventPayload, type OperationalAEP, type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 export declare const stringifyError: (error: unknown) => string | undefined;
-export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjectId: T, error: string) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
+export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjectId: T, error: string, resourceId?: string) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
     error: string;
+    resourceId?: string;
 }>;
-export declare const fetchErrorPayload: (error: string) => RendererSyncBlockEventPayload;
-export declare const getSourceInfoErrorPayload: (error: string) => RendererSyncBlockEventPayload;
-export declare const updateErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const updateReferenceErrorPayload: (error: string) => RendererSyncBlockEventPayload;
-export declare const createErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const deleteErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const updateCacheErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const fetchReferencesErrorPayload: (error: string) => SyncBlockEventPayload;
+export declare const fetchErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
+export declare const getSourceInfoErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
+export declare const updateErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const updateReferenceErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
+export declare const createErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const deleteErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const updateCacheErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const fetchReferencesErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const fetchSuccessPayload: (resourceId: string, blockInstanceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
+export declare const createSuccessPayload: (resourceId: string) => SyncBlockEventPayload;
+export declare const updateSuccessPayload: (resourceId: string, hasReference?: boolean) => SyncBlockEventPayload;
+export declare const deleteSuccessPayload: (resourceId: string) => SyncBlockEventPayload;

package/dist/types/utils/experienceTracking.d.ts

@@ -0,0 +1,51 @@
+import { type DispatchAnalyticsEvent, type SyncBlockEventPayload, type RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
+import { Experience } from '@atlaskit/editor-common/experiences';
+export declare const createExperienceDispatcher: (fireAnalyticsEvent?: ((payload: SyncBlockEventPayload) => void) | ((payload: RendererSyncBlockEventPayload) => void)) => DispatchAnalyticsEvent;
+/**
+ * This experience tracks when a source sync block is saved to the BE.
+ *
+ * Start: When the flush source sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+export declare const getSaveSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a reference sync block is saved to the BE.
+ *
+ * Start: When the flush sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+export declare const getSaveReferenceExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a reference sync block data is fetched from the BE.
+ *
+ * Start: When the fetchNodesData function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getFetchExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getFetchSourceInfoExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a source sync block is deleted from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getDeleteSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a source sync block is created and registered to the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getCreateSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;

package/dist/types-ts4.5/clients/block-service/blockService.d.ts

@@ -92,14 +92,14 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
     documentAri: string;
     noContent?: boolean;
 };
-type BlockIdentifier = {
-    blockAri: string;
-    blockInstanceId: string;
-};
 export type BatchRetrieveSyncedBlocksRequest = {
     blockIdentifiers: BlockIdentifier[];
     documentAri: string;
 };
+type BlockIdentifier = {
+    blockAri: string;
+    blockInstanceId: string;
+};
 export type BatchRetrieveSyncedBlocksResponse = {
     error?: Array<ErrorResponse>;
     success?: Array<BlockContentResponse>;
@@ -116,7 +116,7 @@ export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
 }
-export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
+export declare const getSyncedBlockContent: ({ blockAri, documentAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
 /**
  * Batch retrieves multiple synced blocks by their ARIs.
  *

package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts

@@ -40,7 +40,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     private extractResourceIdFromBlockAri;
     /**
      * Batch fetches multiple synced blocks by their resource IDs.
-     * @param blockNodeIdentifiers - Array of block node identifiers, containing block instance (local) ID + resource IDs to fetch
+     * @param resourceIds - Array of resource IDs to fetch
      * @returns Array of SyncBlockInstance results
      */
     batchFetchData(blockNodeIdentifiers: BlockNodeIdentifiers[]): Promise<SyncBlockInstance[]>;

package/dist/types-ts4.5/providers/types.d.ts

@@ -5,6 +5,10 @@ import type { MentionProvider } from '@atlaskit/mention/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs, ReferenceSyncBlockData } from '../common/types';
+export type BlockNodeIdentifiers = {
+    blockInstanceId: string;
+    resourceId: string;
+};
 /**
  * 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.
@@ -52,10 +56,6 @@ export type UpdateReferenceSyncBlockResult = {
     error?: string;
     success: boolean;
 };
-export type BlockNodeIdentifiers = {
-    blockInstanceId: string;
-    resourceId: string;
-};
 export interface ADFFetchProvider {
     batchFetchData: (blockNodeIdentifiers: BlockNodeIdentifiers[]) => Promise<SyncBlockInstance[]>;
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
@@ -88,8 +88,8 @@ export type SyncedBlockRendererDataProviders = {
 export type SyncBlockRendererProviderCreator = {
     createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider> | undefined) | undefined;
     createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider> | undefined) | undefined;
-    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
     createSSRMediaProvider?: ((options: MediaEmojiProviderOptions) => MediaProvider | undefined) | undefined;
+    createSmartLinkProvider: (() => Promise<CardProvider>) | undefined;
 };
 export type SyncedBlockRendererProviderOptions = {
     parentDataProviders?: SyncedBlockRendererDataProviders;

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

@@ -22,7 +22,6 @@ export declare class ReferenceSyncBlockStoreManager {
     private saveExperience;
     constructor(dataProvider?: SyncBlockDataProvider);
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
-    setExperiences(fetchExperience: Experience, fetchSourceInfoExperience: Experience, saveExperience: Experience): void;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     updateFireAnalyticsEvent(fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void): void;
     getInitialSyncBlockData(resourceId: ResourceId): SyncBlockInstance | undefined;

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

@@ -1,5 +1,4 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
-import type { Experience } from '@atlaskit/editor-common/experiences';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockAttrs, type BlockInstanceId } from '../common/types';
 import type { SyncBlockDataProvider, SyncBlockSourceInfo } from '../providers/types';
@@ -16,14 +15,11 @@ export declare class SourceSyncBlockStoreManager {
     private deletionRetryInfo?;
     private pendingResourceId?;
     private creationCallback?;
-    createExperience: Experience | undefined;
+    private createExperience;
     private saveExperience;
     private deleteExperience;
     constructor(dataProvider?: SyncBlockDataProvider);
     setFireAnalyticsEvent(fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void): void;
-    setCreateExperience(createExperience: Experience): void;
-    setSaveExperience(saveExperience: Experience): void;
-    setDeleteExperience(deleteExperience: Experience): void;
     isSourceBlock(node: PMNode): boolean;
     /**
      * Add/update a sync block node to/from the local cache

package/dist/types-ts4.5/utils/errorHandling.d.ts

@@ -1,13 +1,18 @@
 import { ACTION, ACTION_SUBJECT, ACTION_SUBJECT_ID, type RendererSyncBlockEventPayload, type OperationalAEP, type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 export declare const stringifyError: (error: unknown) => string | undefined;
-export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjectId: T, error: string) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
+export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjectId: T, error: string, resourceId?: string) => OperationalAEP<ACTION.ERROR, ACTION_SUBJECT.SYNCED_BLOCK, T, {
     error: string;
+    resourceId?: string;
 }>;
-export declare const fetchErrorPayload: (error: string) => RendererSyncBlockEventPayload;
-export declare const getSourceInfoErrorPayload: (error: string) => RendererSyncBlockEventPayload;
-export declare const updateErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const updateReferenceErrorPayload: (error: string) => RendererSyncBlockEventPayload;
-export declare const createErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const deleteErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const updateCacheErrorPayload: (error: string) => SyncBlockEventPayload;
-export declare const fetchReferencesErrorPayload: (error: string) => SyncBlockEventPayload;
+export declare const fetchErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
+export declare const getSourceInfoErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
+export declare const updateErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const updateReferenceErrorPayload: (error: string, resourceId?: string) => RendererSyncBlockEventPayload;
+export declare const createErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const deleteErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const updateCacheErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const fetchReferencesErrorPayload: (error: string, resourceId?: string) => SyncBlockEventPayload;
+export declare const fetchSuccessPayload: (resourceId: string, blockInstanceId?: string, sourceProduct?: string) => RendererSyncBlockEventPayload;
+export declare const createSuccessPayload: (resourceId: string) => SyncBlockEventPayload;
+export declare const updateSuccessPayload: (resourceId: string, hasReference?: boolean) => SyncBlockEventPayload;
+export declare const deleteSuccessPayload: (resourceId: string) => SyncBlockEventPayload;

package/dist/types-ts4.5/utils/experienceTracking.d.ts

@@ -0,0 +1,51 @@
+import { type DispatchAnalyticsEvent, type SyncBlockEventPayload, type RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
+import { Experience } from '@atlaskit/editor-common/experiences';
+export declare const createExperienceDispatcher: (fireAnalyticsEvent?: ((payload: SyncBlockEventPayload) => void) | ((payload: RendererSyncBlockEventPayload) => void)) => DispatchAnalyticsEvent;
+/**
+ * This experience tracks when a source sync block is saved to the BE.
+ *
+ * Start: When the flush source sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+export declare const getSaveSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a reference sync block is saved to the BE.
+ *
+ * Start: When the flush sync block function is called.
+ * Success: When the sync block save is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the sync block being successfully saved
+ */
+export declare const getSaveReferenceExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a reference sync block data is fetched from the BE.
+ *
+ * Start: When the fetchNodesData function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getFetchExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a reference sync block source info data (title, url) is fetched from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getFetchSourceInfoExperience: (fireAnalyticsEvent?: (payload: RendererSyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a source sync block is deleted from the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getDeleteSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;
+/**
+ * This experience tracks when a source sync block is created and registered to the BE.
+ *
+ * Start: When the fetchSourceInfo function is called.
+ * Success: When the fetching the data is successful within the timeout duration of start.
+ * Failure: When the timeout duration passes without the data being successfully fetched, or the fetch fails
+ */
+export declare const getCreateSourceExperience: (fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => Experience;

package/package.json

@@ -24,7 +24,7 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-utils": "^19.26.0",
+		"@atlaskit/adf-utils": "^19.27.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "^7.2.0",
 		"@atlaskit/node-data-provider": "^8.0.0",
@@ -77,7 +77,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "3.11.0",
+	"version": "3.12.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",