@atlaskit/editor-synced-block-provider 2.8.0 → 2.9.1

package/dist/types/hooks/useFetchSyncBlockData.d.ts

@@ -1,7 +1,9 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { SyncBlockInstance } from '../providers/types';
 import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
 export interface UseFetchSyncBlockDataResult {
     isLoading: boolean;
+    providerFactory: ProviderFactory | undefined;
     reloadData: () => Promise<void>;
     syncBlockInstance: SyncBlockInstance | null;
 }

package/dist/types/index.d.ts

@@ -10,6 +10,6 @@ export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvide
 export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
+export { blockResourceIdFromSourceAndLocalId, getConfluencePageAri, getLocalIdFromAri, getLocalIdFromResourceId, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
 export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

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

@@ -12,6 +12,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 export declare const useMemoizedBlockServiceAPIProviders: () => {
     fetchProvider: BlockServiceADFFetchProvider;

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

@@ -24,6 +24,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     private createNewContentProperty;
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 /**
  * Convenience function to create providers with default content property key

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

@@ -1,16 +1,47 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import { type SyncBlockData, type SyncBlockNode } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type WriteSyncBlockResult } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
     private writeProvider;
     private sourceId;
-    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string);
+    private providerOptions;
+    /**
+     * Constructor for the SyncBlockProvider
+     *
+     * @param fetchProvider
+     * @param writeProvider
+     * @param sourceId
+     * @param nestedRendererDataProviders
+     */
+    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions);
+    /**
+     * Check if the node is supported by the provider
+     *
+     * @param node
+     *
+     * @returns True if the node is supported, false otherwise
+     */
     isNodeSupported(node: JSONNode): node is SyncBlockNode;
+    /**
+     * Get the data key for the node
+     *
+     * @param node
+     *
+     * @returns The data key
+     */
     nodeDataKey(node: SyncBlockNode): string;
+    /**
+     * Fetch the data from the fetch provider
+     *
+     * @param nodes
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     fetchNodesData(nodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     /**
+     * Write the data to the write provider
      *
      * @param nodes
      * @param data
@@ -19,8 +50,34 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
+    /**
+     * Delete the data from the write provider
+     *
+     * @param resourceIds
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
+    /**
+     * Get the source id
+     *
+     * @returns The source id
+     */
     getSourceId(): string;
+    /**
+     * Retrieve the source info from the source id
+     *
+     * @param node
+     *
+     * @returns The source info
+     */
     retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    generateResourceId(sourceId: string, localId: string): string;
+    /**
+     * Get the synced block renderer provider options
+     *
+     * @returns The synced block renderer provider options
+     */
+    getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
 }
-export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;
+export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions) => SyncBlockProvider;

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

@@ -1,3 +1,5 @@
+import type { SyncedBlockRendererDataProviders, MediaProvider } from '@atlaskit/editor-common/provider-factory';
+import type { EmojiProvider } from '@atlaskit/emoji';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode } from '../common/types';
 /**
@@ -28,13 +30,34 @@ export interface ADFFetchProvider {
 }
 export interface ADFWriteProvider {
     deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
+    generateResourceId: (sourceId: string, localId: string) => ResourceId;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
+export type MediaEmojiProviderOptions = {
+    contentId: string;
+    contentType: string;
+    spaceKey?: string | null;
+};
+export type SyncedBlockRendererProviderOptions = {
+    parentDataProviders?: SyncedBlockRendererDataProviders;
+    providerCreator?: {
+        createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider>) | undefined;
+        createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider>) | undefined;
+    };
+};
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
+    /**
+     * Generates a resource ID from a source ID and local ID.
+     * @param sourceId - The source document ID (e.g., page ARI)
+     * @param localId - The local block ID (usually a UUID)
+     * @returns The generated resource ID
+     */
+    abstract generateResourceId(sourceId: ResourceId, localId: string): ResourceId;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -1,3 +1,4 @@
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockNode } from '../common/types';
 import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
@@ -6,6 +7,7 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockCache;
     private subscriptions;
     private titleSubscriptions;
+    private providerFactories;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -29,5 +31,6 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns
      */
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
+    getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

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

@@ -1,3 +1,4 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { EditorView } from '@atlaskit/editor-prosemirror/dist/types/view';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
@@ -60,5 +61,6 @@ export declare class SyncBlockStoreManager {
     refreshSubscriptions(): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    getReferenceSyncBlockProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

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

@@ -6,5 +6,19 @@ export declare const getPageIdAndTypeFromAri: (ari: string) => {
 };
 export declare const getLocalIdFromAri: (ari: string) => string;
 export declare const getPageARIFromResourceId: (resourceId: string) => string;
-export declare const getContentPropertyAri: (contentPropertyId: string, cloudId: string) => string;
 export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * For the following functions, they are used for the block service API provider.
+ * The resourceId/blockResourceId always refers to the block ARI.
+ */
+/**
+ * @param sourceId - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param localId - the localId of the block node. A randomly generated UUID
+ * @returns the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ */
+export declare const blockResourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * @param ari - the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ * @returns the localId of the block node. A randomly generated UUID
+ */
+export declare const getLocalIdFromResourceId: (ari: string) => string;

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

@@ -34,6 +34,6 @@ export declare class BlockError extends Error {
     constructor(status: number);
 }
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
-export declare const deleteSyncedBlock: ({ blockAri, }: DeleteSyncedBlockRequest) => Promise<void>;
+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>;

package/dist/types-ts4.5/hooks/useFetchSyncBlockData.d.ts

@@ -1,7 +1,9 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { SyncBlockInstance } from '../providers/types';
 import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
 export interface UseFetchSyncBlockDataResult {
     isLoading: boolean;
+    providerFactory: ProviderFactory | undefined;
     reloadData: () => Promise<void>;
     syncBlockInstance: SyncBlockInstance | null;
 }

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

@@ -10,6 +10,6 @@ export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvide
 export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
+export { blockResourceIdFromSourceAndLocalId, getConfluencePageAri, getLocalIdFromAri, getLocalIdFromResourceId, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
 export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

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

@@ -12,6 +12,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
 declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 export declare const useMemoizedBlockServiceAPIProviders: () => {
     fetchProvider: BlockServiceADFFetchProvider;

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

@@ -24,6 +24,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     private createNewContentProperty;
     writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
+    generateResourceId(sourceId: string, localId: string): string;
 }
 /**
  * Convenience function to create providers with default content property key

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

@@ -1,16 +1,47 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 import { type SyncBlockData, type SyncBlockNode } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type WriteSyncBlockResult } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
     private writeProvider;
     private sourceId;
-    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string);
+    private providerOptions;
+    /**
+     * Constructor for the SyncBlockProvider
+     *
+     * @param fetchProvider
+     * @param writeProvider
+     * @param sourceId
+     * @param nestedRendererDataProviders
+     */
+    constructor(fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions);
+    /**
+     * Check if the node is supported by the provider
+     *
+     * @param node
+     *
+     * @returns True if the node is supported, false otherwise
+     */
     isNodeSupported(node: JSONNode): node is SyncBlockNode;
+    /**
+     * Get the data key for the node
+     *
+     * @param node
+     *
+     * @returns The data key
+     */
     nodeDataKey(node: SyncBlockNode): string;
+    /**
+     * Fetch the data from the fetch provider
+     *
+     * @param nodes
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     fetchNodesData(nodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     /**
+     * Write the data to the write provider
      *
      * @param nodes
      * @param data
@@ -19,8 +50,34 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
+    /**
+     * Delete the data from the write provider
+     *
+     * @param resourceIds
+     *
+     * @returns Array of {resourceId?: string, error?: string}.
+     */
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
+    /**
+     * Get the source id
+     *
+     * @returns The source id
+     */
     getSourceId(): string;
+    /**
+     * Retrieve the source info from the source id
+     *
+     * @param node
+     *
+     * @returns The source info
+     */
     retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    generateResourceId(sourceId: string, localId: string): string;
+    /**
+     * Get the synced block renderer provider options
+     *
+     * @returns The synced block renderer provider options
+     */
+    getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
 }
-export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;
+export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions) => SyncBlockProvider;

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

@@ -1,3 +1,5 @@
+import type { SyncedBlockRendererDataProviders, MediaProvider } from '@atlaskit/editor-common/provider-factory';
+import type { EmojiProvider } from '@atlaskit/emoji';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
 import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode } from '../common/types';
 /**
@@ -28,13 +30,34 @@ export interface ADFFetchProvider {
 }
 export interface ADFWriteProvider {
     deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
+    generateResourceId: (sourceId: string, localId: string) => ResourceId;
     writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
+export type MediaEmojiProviderOptions = {
+    contentId: string;
+    contentType: string;
+    spaceKey?: string | null;
+};
+export type SyncedBlockRendererProviderOptions = {
+    parentDataProviders?: SyncedBlockRendererDataProviders;
+    providerCreator?: {
+        createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider>) | undefined;
+        createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider>) | undefined;
+    };
+};
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
+    abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
+    /**
+     * Generates a resource ID from a source ID and local ID.
+     * @param sourceId - The source document ID (e.g., page ARI)
+     * @param localId - The local block ID (usually a UUID)
+     * @returns The generated resource ID
+     */
+    abstract generateResourceId(sourceId: ResourceId, localId: string): ResourceId;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
 export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -1,3 +1,4 @@
+import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import { type ResourceId, type SyncBlockNode } from '../common/types';
 import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
@@ -6,6 +7,7 @@ export declare class ReferenceSyncBlockStoreManager {
     private syncBlockCache;
     private subscriptions;
     private titleSubscriptions;
+    private providerFactories;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -29,5 +31,6 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns
      */
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
+    getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

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

@@ -1,3 +1,4 @@
+import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
 import type { EditorView } from '@atlaskit/editor-prosemirror/dist/types/view';
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
@@ -60,5 +61,6 @@ export declare class SyncBlockStoreManager {
     refreshSubscriptions(): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    getReferenceSyncBlockProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
     destroy(): void;
 }

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

@@ -6,5 +6,19 @@ export declare const getPageIdAndTypeFromAri: (ari: string) => {
 };
 export declare const getLocalIdFromAri: (ari: string) => string;
 export declare const getPageARIFromResourceId: (resourceId: string) => string;
-export declare const getContentPropertyAri: (contentPropertyId: string, cloudId: string) => string;
 export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * For the following functions, they are used for the block service API provider.
+ * The resourceId/blockResourceId always refers to the block ARI.
+ */
+/**
+ * @param sourceId - the ARI of the document. E.G ari:cloud:confluence:cloudId:page/pageId
+ * @param localId - the localId of the block node. A randomly generated UUID
+ * @returns the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ */
+export declare const blockResourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;
+/**
+ * @param ari - the block ARI. E.G ari:cloud:blocks:cloudId:synced-block/localId
+ * @returns the localId of the block node. A randomly generated UUID
+ */
+export declare const getLocalIdFromResourceId: (ari: string) => string;

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

@@ -34,6 +34,6 @@ export declare class BlockError extends Error {
     constructor(status: number);
 }
 export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockContentRequest) => Promise<BlockContentResponse>;
-export declare const deleteSyncedBlock: ({ blockAri, }: DeleteSyncedBlockRequest) => Promise<void>;
+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>;

package/package.json

@@ -30,6 +30,7 @@
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/node-data-provider": "^7.5.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
 		"@atlaskit/primitives": "^16.1.0",
 		"@atlaskit/tokens": "^8.0.0",
 		"@babel/runtime": "^7.0.0",
@@ -37,6 +38,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
+		"@atlaskit/editor-common": "^110.30.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -82,11 +84,16 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.8.0",
+	"version": "2.9.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
+	},
+	"platform-feature-flags": {
+		"platform_editor_synced_block_provider_use_block_service": {
+			"type": "boolean"
+		}
 	}
 }