@atlaskit/editor-synced-block-provider 2.9.0 → 2.10.1

package/dist/esm/utils/ari.js

@@ -4,6 +4,8 @@ export var getConfluencePageAri = function getConfluencePageAri(pageId, cloudId)
   var pageType = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 'page';
   return "ari:cloud:confluence:".concat(cloudId, ":").concat(pageType, "/").concat(pageId);
 };
+
+// For extracting from Page ARI and also the content property's version of resourceId 
 export var getPageIdAndTypeFromAri = function getPageIdAndTypeFromAri(ari) {
   var match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/(\d+)/);
   if (match !== null && match !== void 0 && match[2]) {
@@ -30,35 +32,4 @@ export var getPageARIFromResourceId = function getPageARIFromResourceId(resource
 };
 export var resourceIdFromSourceAndLocalId = function resourceIdFromSourceAndLocalId(sourceId, localId) {
   return sourceId + '/' + localId;
-};
-
-/**
- * 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 var blockResourceIdFromSourceAndLocalId = function blockResourceIdFromSourceAndLocalId(sourceId, localId) {
-  var match = sourceId.match(/ari:cloud:confluence:([^:]+):(page|blogpost)\/.*/);
-  if (!(match !== null && match !== void 0 && match[1])) {
-    throw new Error("Invalid source ARI: ".concat(sourceId));
-  }
-  var cloudId = match[1];
-  return "ari:cloud:blocks:".concat(cloudId, ":synced-block/").concat(localId);
-};
-
-/**
- * @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 var getLocalIdFromResourceId = function getLocalIdFromResourceId(ari) {
-  var match = ari.match(/ari:cloud:confluence:[^:]+:(page|blogpost)\/\d+\/([a-zA-Z0-9-]+)/);
-  if (match !== null && match !== void 0 && match[2]) {
-    return match[2];
-  }
-  throw new Error("Invalid page ARI: ".concat(ari));
 };

package/dist/esm/utils/sourceInfo.js

@@ -64,15 +64,15 @@ var getSourceInfo = /*#__PURE__*/function () {
   };
 }();
 export var fetchSourceInfo = /*#__PURE__*/function () {
-  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(ari, localId) {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee2(pageAri, localId) {
     var _response$data, _contentData$space, _getPageIdAndTypeFrom, pageType, response, contentData, title, url, _ref3, base;
     return _regeneratorRuntime.wrap(function _callee2$(_context2) {
       while (1) switch (_context2.prev = _context2.next) {
         case 0:
           _context2.prev = 0;
-          _getPageIdAndTypeFrom = getPageIdAndTypeFromAri(ari), pageType = _getPageIdAndTypeFrom.type;
+          _getPageIdAndTypeFrom = getPageIdAndTypeFromAri(pageAri), pageType = _getPageIdAndTypeFrom.type;
           _context2.next = 4;
-          return getSourceInfo(ari);
+          return getSourceInfo(pageAri);
         case 4:
           response = _context2.sent;
           contentData = (_response$data = response.data) === null || _response$data === void 0 || (_response$data = _response$data.content) === null || _response$data === void 0 || (_response$data = _response$data.nodes) === null || _response$data === void 0 ? void 0 : _response$data[0];

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

@@ -4,12 +4,13 @@ export type { SyncBlockData, SyncBlockNode } from './common/types';
 export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hooks/useFetchSyncBlockData';
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
+export { blockResourceIdFromSourceAndLocalId, getLocalIdFromResourceId } from './providers/block-service/ari';
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
 export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { blockResourceIdFromSourceAndLocalId, getConfluencePageAri, getLocalIdFromAri, getLocalIdFromResourceId, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
+export { getConfluencePageAri, getLocalIdFromAri, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
 export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

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

@@ -0,0 +1,13 @@
+/**
+ * Generates a unique block ARI from a source ARI and a local ID.
+ * @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;
+/**
+ * Extracts the local ID from a block ARI.
+ * @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/providers/block-service/blockServiceAPI.d.ts

@@ -1,10 +1,11 @@
-import { type SyncBlockData } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { type ResourceId, type SyncBlockData } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SourceInfoFetchData, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */
 declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     fetchData(resourceId: string): Promise<SyncBlockInstance>;
+    retrieveSourceInfoFetchData(resourceId: ResourceId, pageARI: string): SourceInfoFetchData;
 }
 /**
  * ADFWriteProvider implementation that writes synced block data to Block Service API

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

@@ -1,5 +1,5 @@
-import { type SyncBlockData } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { type ResourceId, type SyncBlockData } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SourceInfoFetchData, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -14,6 +14,7 @@ declare class ConfluenceADFFetchProvider implements ADFFetchProvider {
     private config;
     constructor(config: ContentAPIConfig);
     fetchData(resourceId: string): Promise<SyncBlockInstance>;
+    retrieveSourceInfoFetchData(resourceId: ResourceId): SourceInfoFetchData;
 }
 /**
  * ADFWriteProvider implementation that writes synced block data to Confluence Content API

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,9 +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';
 /**
@@ -23,19 +25,37 @@ export type WriteSyncBlockResult = {
     error?: string;
     resourceId?: string;
 };
+export type SourceInfoFetchData = {
+    pageARI: string;
+    sourceLocalId?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
+    retrieveSourceInfoFetchData: (resourceId: ResourceId, pageAri: string) => SourceInfoFetchData;
 }
 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)

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

@@ -7,18 +7,3 @@ export declare const getPageIdAndTypeFromAri: (ari: string) => {
 export declare const getLocalIdFromAri: (ari: string) => string;
 export declare const getPageARIFromResourceId: (resourceId: 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/sourceInfo.d.ts

@@ -1,2 +1,2 @@
 import type { SyncBlockSourceInfo } from '../providers/types';
-export declare const fetchSourceInfo: (ari: string, localId?: string) => Promise<SyncBlockSourceInfo | undefined>;
+export declare const fetchSourceInfo: (pageAri: string, localId?: string) => Promise<SyncBlockSourceInfo | undefined>;

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

@@ -4,12 +4,13 @@ export type { SyncBlockData, SyncBlockNode } from './common/types';
 export { useFetchSyncBlockData, type UseFetchSyncBlockDataResult, } from './hooks/useFetchSyncBlockData';
 export { useFetchSyncBlockTitle } from './hooks/useFetchSyncBlockTitle';
 export { useHandleContentChanges } from './hooks/useHandleContentChanges';
+export { blockResourceIdFromSourceAndLocalId, getLocalIdFromResourceId } from './providers/block-service/ari';
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
 export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { blockResourceIdFromSourceAndLocalId, getConfluencePageAri, getLocalIdFromAri, getLocalIdFromResourceId, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
+export { getConfluencePageAri, getLocalIdFromAri, 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/ari.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generates a unique block ARI from a source ARI and a local ID.
+ * @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;
+/**
+ * Extracts the local ID from a block ARI.
+ * @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/providers/block-service/blockServiceAPI.d.ts

@@ -1,10 +1,11 @@
-import { type SyncBlockData } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { type ResourceId, type SyncBlockData } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SourceInfoFetchData, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 /**
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
  */
 declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
     fetchData(resourceId: string): Promise<SyncBlockInstance>;
+    retrieveSourceInfoFetchData(resourceId: ResourceId, pageARI: string): SourceInfoFetchData;
 }
 /**
  * ADFWriteProvider implementation that writes synced block data to Block Service API

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

@@ -1,5 +1,5 @@
-import { type SyncBlockData } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
+import { type ResourceId, type SyncBlockData } from '../../common/types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SourceInfoFetchData, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -14,6 +14,7 @@ declare class ConfluenceADFFetchProvider implements ADFFetchProvider {
     private config;
     constructor(config: ContentAPIConfig);
     fetchData(resourceId: string): Promise<SyncBlockInstance>;
+    retrieveSourceInfoFetchData(resourceId: ResourceId): SourceInfoFetchData;
 }
 /**
  * ADFWriteProvider implementation that writes synced block data to Confluence Content API

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,9 +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';
 /**
@@ -23,19 +25,37 @@ export type WriteSyncBlockResult = {
     error?: string;
     resourceId?: string;
 };
+export type SourceInfoFetchData = {
+    pageARI: string;
+    sourceLocalId?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
+    retrieveSourceInfoFetchData: (resourceId: ResourceId, pageAri: string) => SourceInfoFetchData;
 }
 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)

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

@@ -7,18 +7,3 @@ export declare const getPageIdAndTypeFromAri: (ari: string) => {
 export declare const getLocalIdFromAri: (ari: string) => string;
 export declare const getPageARIFromResourceId: (resourceId: 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/sourceInfo.d.ts

@@ -1,2 +1,2 @@
 import type { SyncBlockSourceInfo } from '../providers/types';
-export declare const fetchSourceInfo: (ari: string, localId?: string) => Promise<SyncBlockSourceInfo | undefined>;
+export declare const fetchSourceInfo: (pageAri: string, localId?: string) => Promise<SyncBlockSourceInfo | undefined>;

package/package.json

@@ -24,13 +24,12 @@
 	],
 	"atlaskit:src": "src/index.ts",
 	"dependencies": {
-		"@atlaskit/adf-schema": "^51.3.2",
+		"@atlaskit/adf-schema": "^51.4.0",
 		"@atlaskit/adf-utils": "^19.26.0",
 		"@atlaskit/css": "^0.15.0",
 		"@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",
@@ -38,6 +37,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
+		"@atlaskit/editor-common": "^110.32.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -83,16 +83,11 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.9.0",
+	"version": "2.10.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"
-		}
 	}
 }