@atlaskit/editor-synced-block-provider 2.15.1 → 2.15.3

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

@@ -15,6 +15,10 @@ export type BlockContentErrorResponse = {
     code: string;
     reason: string;
 };
+type ReferenceSyncedBlockResponse = {
+    blocks?: Array<BlockContentResponse>;
+    errors?: Array<BlockContentErrorResponse>;
+};
 export declare const isBlockContentResponse: (response: BlockContentResponse | BlockContentErrorResponse) => response is BlockContentResponse;
 /**
  * Retrieves all synced blocks referenced in a document.
@@ -58,10 +62,7 @@ export declare const isBlockContentResponse: (response: BlockContentResponse | B
  * ```
  * Check https://block-service.dev.atl-paas.net/ for latest API documentation.
  */
-export declare const getReferenceSyncedBlocks: (documentAri: string) => Promise<{
-    blocks?: Array<BlockContentResponse>;
-    errors?: Array<BlockContentErrorResponse>;
-}>;
+export declare const getReferenceSyncedBlocks: (documentAri: string) => Promise<ReferenceSyncedBlockResponse>;
 export type GetSyncedBlockContentRequest = {
     blockAri: string;
 };
@@ -79,6 +80,15 @@ export type CreateSyncedBlockRequest = {
     product: SyncBlockProduct;
     sourceAri: string;
 };
+type ReferenceSyncedBlockIDs = {
+    blockAri: string;
+    blockInstanceId: string;
+};
+type UpdateReferenceSyncedBlockOnDocumentRequest = {
+    blocks: ReferenceSyncedBlockIDs[];
+    documentAri: string;
+    noContent?: boolean;
+};
 export declare class BlockError extends Error {
     readonly status: number;
     constructor(status: number);
@@ -87,3 +97,5 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
 export declare const deleteSyncedBlock: ({ blockAri }: DeleteSyncedBlockRequest) => Promise<void>;
 export declare const updateSyncedBlock: ({ blockAri, content, }: UpdateSyncedBlockRequest) => Promise<void>;
 export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
+export declare const updateReferenceSyncedBlockOnDocument: ({ documentAri, blocks, noContent, }: UpdateReferenceSyncedBlockOnDocumentRequest) => Promise<ReferenceSyncedBlockResponse | void>;
+export {};

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

@@ -1,5 +1,5 @@
-import { SyncBlockError, type ResourceId, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { SyncBlockError, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, UpdateReferenceSyncBlockResult, WriteSyncBlockResult } from '../types';
 export declare const fetchReferences: (documentAri: string) => Promise<SyncBlockInstance[] | SyncBlockError>;
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
@@ -22,6 +22,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
     generateResourceId(): ResourceId;
+    updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 export declare const useMemoizedBlockServiceAPIProviders: (sourceAri: string, product: SyncBlockProduct, sourceDocumentId: string) => {
     fetchProvider: BlockServiceADFFetchProvider;

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

@@ -1,5 +1,5 @@
-import { type ResourceId, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockProduct } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, UpdateReferenceSyncBlockResult, WriteSyncBlockResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -28,6 +28,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
     generateResourceId(sourceId: string, localId: string): string;
     generateResourceIdForReference(sourceId: ResourceId): ResourceId;
+    updateReferenceData(_blocks: SyncBlockAttrs[], _noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 /**
  * Convenience function to create providers with default content property key

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

@@ -1,7 +1,7 @@
 import type { RendererSyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import { type BlockInstanceId, type ResourceId, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockParentInfo, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
+import { type BlockInstanceId, type ResourceId, type SyncBlockAttrs, type SyncBlockData, type SyncBlockNode, type SyncBlockProduct } from '../common/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockParentInfo, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type UpdateReferenceSyncBlockResult, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -94,5 +94,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @returns The parent info for the sync block
      */
     retrieveSyncBlockParentInfo(sourceAri: string, sourceProduct: SyncBlockProduct): SyncBlockParentInfo | undefined;
+    updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions, getSSRData?: () => Record<string, SyncBlockInstance> | undefined) => SyncBlockProvider;

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

@@ -4,7 +4,7 @@ import type { EmojiProvider } from '@atlaskit/emoji';
 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 } from '../common/types';
+import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct, BlockInstanceId, SyncBlockAttrs } from '../common/types';
 /**
  * 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.
@@ -39,15 +39,26 @@ export type SourceInfoFetchData = {
     pageARI: string;
     sourceLocalId?: string;
 };
+export type UpdateReferenceSyncBlockResult = {
+    error?: string;
+    success: boolean;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
 export interface ADFWriteProvider {
     createData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
+    /**
+     * Delete source block.
+     * @param resourceId the resourceId of the block to be deleted
+     * @returns Object representing the result of the deletion. {resourceId: string, success: boolean, error?: string}.
+     * User should not be blocked by not_found error when deleting, so successful result should be returned for 404 error
+     */
     deleteData: (resourceId: ResourceId) => Promise<DeleteSyncBlockResult>;
     generateResourceId: (sourceId: string, localId: string) => ResourceId;
     generateResourceIdForReference: (sourceId: ResourceId) => ResourceId;
     product: SyncBlockProduct;
+    updateReferenceData: (blocks: SyncBlockAttrs[], noContent?: boolean) => Promise<UpdateReferenceSyncBlockResult>;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
 export type MediaEmojiProviderOptions = {
@@ -84,6 +95,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
      */
     abstract generateResourceId(sourceId: ResourceId, localId: BlockInstanceId): ResourceId;
     abstract generateResourceIdForReference(sourceId: ResourceId): ResourceId;
+    abstract updateReferenceData(blocks: SyncBlockAttrs[], noContent?: boolean): Promise<UpdateReferenceSyncBlockResult>;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -6,6 +6,7 @@ import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, Ti
 export declare class ReferenceSyncBlockStoreManager {
     private dataProvider?;
     private syncBlockCache;
+    private isCacheDirty;
     private subscriptions;
     private titleSubscriptions;
     private providerFactories;
@@ -44,5 +45,11 @@ export declare class ReferenceSyncBlockStoreManager {
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
     getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     private retrieveDynamicProviders;
+    /**
+     * Update reference synced blocks on the document with the BE
+     *
+     * @returns true if the reference synced blocks are updated successfully, false otherwise
+     */
+    flush(): Promise<boolean>;
     destroy(): void;
 }

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

@@ -1,6 +1,6 @@
 import { type SyncBlockEventPayload } from '@atlaskit/editor-common/analytics';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { ResourceId, SyncBlockAttrs } from '../common/types';
+import { type ResourceId, type SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = (syncBlockCount: number) => Promise<boolean>;
 type OnDelete = () => void;

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

@@ -6,6 +6,7 @@ export declare const getErrorPayload: <T extends ACTION_SUBJECT_ID>(actionSubjec
 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;

package/package.json

@@ -24,10 +24,9 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^51.5.1",
 		"@atlaskit/adf-utils": "^19.26.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
-		"@atlaskit/editor-prosemirror": "7.0.0",
+		"@atlaskit/editor-prosemirror": "^7.2.0",
 		"@atlaskit/node-data-provider": "^7.5.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.6",
@@ -77,7 +76,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.15.1",
+	"version": "2.15.3",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",