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

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

@@ -1,10 +1,9 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockData, BlockInstanceId, ResourceId, SyncBlockNode } from '../common/types';
-import type { PAGE_TYPE } from './ari';
 export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode) => SyncBlockData;
-export declare const isBlogPageType: (pageType: PAGE_TYPE) => boolean;
 export declare const createSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;
 export declare const createBodiedSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;
 export declare const convertSyncBlockJSONNodeToSyncBlockNode: (node: JSONNode) => SyncBlockNode | undefined;
 export declare const convertPMNodeToSyncBlockNode: (node: PMNode) => SyncBlockNode | undefined;
+export declare const convertPMNodesToSyncBlockNodes: (nodes: PMNode[]) => SyncBlockNode[];

package/dist/types-ts4.5/{providers → clients}/block-service/ari.d.ts

@@ -10,4 +10,4 @@ export declare const blockResourceIdFromSourceAndLocalId: (sourceId: string, loc
  * @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;
+export declare const getLocalIdFromBlockResourceId: (ari: string) => string;

package/dist/types-ts4.5/{utils → clients/block-service}/blockService.d.ts

@@ -1,4 +1,4 @@
-export type BlockProduct = 'confluence-page' | 'jira-work-item';
+import type { SyncBlockProduct } from '../../common/types';
 export type BlockContentResponse = {
     blockAri: string;
     blockInstanceId: string;
@@ -7,7 +7,7 @@ export type BlockContentResponse = {
     createdAt: number;
     createdBy: string;
     isSynced: boolean;
-    product: BlockProduct;
+    product: SyncBlockProduct;
     sourceAri: string;
     status: 'active' | 'deleted';
     version: number;
@@ -26,7 +26,7 @@ export type CreateSyncedBlockRequest = {
     blockAri: string;
     blockInstanceId: string;
     content: string;
-    product: string;
+    product: SyncBlockProduct;
     sourceAri: string;
 };
 export declare class BlockError extends Error {

package/dist/types-ts4.5/clients/confluence/ari.d.ts

@@ -0,0 +1,9 @@
+export type PAGE_TYPE = 'page' | 'blogpost';
+export declare const getConfluencePageAri: (pageId: string, cloudId: string, pageType?: PAGE_TYPE) => string;
+export declare const getPageIdAndTypeFromConfluencePageAri: (ari: string) => {
+    id: string;
+    type: PAGE_TYPE;
+};
+export declare const getLocalIdFromConfluencePageAri: (ari: string) => string;
+export declare const getPageARIFromContentPropertyResourceId: (resourceId: string) => string;
+export declare const resourceIdFromConfluencePageSourceIdAndLocalId: (sourceId: string, localId: string) => string;

package/dist/types-ts4.5/{utils → clients/confluence}/contentProperty.d.ts

@@ -1,4 +1,4 @@
-import type { SyncBlockData } from '../common/types';
+import type { SyncBlockData } from '../../common/types';
 import { type PAGE_TYPE } from './ari';
 type GetContentPropertyOptions = {
     cloudId: string;

package/dist/types-ts4.5/clients/confluence/sourceInfo.d.ts

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

package/dist/types-ts4.5/clients/confluence/utils.d.ts

@@ -0,0 +1,2 @@
+import type { PAGE_TYPE } from './ari';
+export declare const isBlogPageType: (pageType: PAGE_TYPE) => boolean;

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

@@ -2,6 +2,7 @@ import type { ADFEntity } from '@atlaskit/adf-utils/types';
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
 export type BlockInstanceId = string;
 export type ResourceId = string;
+export type SyncBlockProduct = 'confluence-page' | 'jira-work-item';
 export type SyncBlockAttrs = {
     localId: BlockInstanceId;
     resourceId: ResourceId;
@@ -22,8 +23,9 @@ export interface SyncBlockData {
     createdAt?: string;
     createdBy?: string;
     isSynced?: boolean;
+    product?: SyncBlockProduct;
     resourceId: ResourceId;
-    sourceDocumentAri?: string;
+    sourceAri?: string;
     sourceTitle?: string;
     sourceURL?: string;
     updatedAt?: string;

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

@@ -4,13 +4,14 @@ 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 { blockResourceIdFromSourceAndLocalId, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
+export { getConfluencePageAri, getLocalIdFromConfluencePageAri, getPageARIFromContentPropertyResourceId, getPageIdAndTypeFromConfluencePageAri, resourceIdFromConfluencePageSourceIdAndLocalId, } from './clients/confluence/ari';
 export { useMemoizedBlockServiceAPIProviders } from './providers/block-service/blockServiceAPI';
 export { createContentAPIProvidersWithDefaultKey, useMemoizedContentAPIProviders, } from './providers/confluence/confluenceContentAPI';
+export { fetchConfluenceSourceInfo } from './clients/confluence/sourceInfo';
 export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
-export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, } from './providers/types';
+export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, } from './providers/types';
 export { ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
 export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { getConfluencePageAri, getLocalIdFromAri, getPageARIFromResourceId, getPageIdAndTypeFromAri, resourceIdFromSourceAndLocalId, } from './utils/ari';
-export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes, } from './utils/utils';

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

@@ -1,6 +1,6 @@
 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 SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockParentInfo, type SyncBlockSourceInfo, type SyncedBlockRendererProviderOptions, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -79,5 +79,14 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @returns The synced block renderer provider options
      */
     getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
+    /**
+     * Retrieve the parent info for the sync block
+     *
+     * @param resourceId
+     * @param syncBlockInstance
+     *
+     * @returns The parent info for the sync block
+     */
+    retrieveSyncBlockParentInfo(syncBlockInstance: SyncBlockInstance | undefined): SyncBlockParentInfo | undefined;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string, providerOptions: SyncedBlockRendererProviderOptions) => SyncBlockProvider;

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

@@ -1,7 +1,9 @@
-import type { SyncedBlockRendererDataProviders, MediaProvider } from '@atlaskit/editor-common/provider-factory';
+import type { MediaProvider, ProfilecardProvider } from '@atlaskit/editor-common/provider-factory';
 import type { EmojiProvider } from '@atlaskit/emoji';
+import type { MentionProvider } from '@atlaskit/mention/types';
 import { NodeDataProvider } from '@atlaskit/node-data-provider';
-import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode } from '../common/types';
+import type { TaskDecisionProvider } from '@atlaskit/task-decision/types';
+import type { SyncBlockData, ResourceId, SyncBlockError, SyncBlockNode, SyncBlockProduct } 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.
@@ -21,6 +23,10 @@ export type SyncBlockSourceInfo = {
     title?: string;
     url?: string;
 };
+export type SyncBlockParentInfo = {
+    contentId: string;
+    contentProduct: SyncBlockProduct;
+};
 export type WriteSyncBlockResult = {
     error?: string;
     resourceId?: string;
@@ -40,15 +46,20 @@ export interface ADFWriteProvider {
 }
 export type MediaEmojiProviderOptions = {
     contentId: string;
-    contentType: string;
-    spaceKey?: string | null;
+    contentProduct: SyncBlockProduct;
+};
+export type SyncedBlockRendererDataProviders = {
+    mentionProvider?: Promise<MentionProvider>;
+    profilecardProvider?: Promise<ProfilecardProvider>;
+    taskDecisionProvider?: Promise<TaskDecisionProvider>;
+};
+export type SyncBlockRendererProviderCreator = {
+    createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider>) | undefined;
+    createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider>) | undefined;
 };
 export type SyncedBlockRendererProviderOptions = {
     parentDataProviders?: SyncedBlockRendererDataProviders;
-    providerCreator?: {
-        createEmojiProvider: ((options: MediaEmojiProviderOptions) => Promise<EmojiProvider>) | undefined;
-        createMediaProvider: ((options: MediaEmojiProviderOptions) => Promise<MediaProvider>) | undefined;
-    };
+    providerCreator?: SyncBlockRendererProviderCreator;
 };
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
@@ -56,6 +67,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceInfo(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
     abstract getSyncedBlockRendererProviderOptions(): SyncedBlockRendererProviderOptions;
+    abstract retrieveSyncBlockParentInfo(syncBlockInstance: SyncBlockInstance | undefined): SyncBlockParentInfo | undefined;
     /**
      * 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

@@ -17,6 +17,11 @@ export declare class ReferenceSyncBlockStoreManager {
      */
     refreshSubscriptions(): Promise<void>;
     private retrieveSyncBlockSourceInfo;
+    /**
+     * Fetch sync block data for a given array of sync block nodes.
+     * @param syncBlockNodes - The array of sync block nodes to fetch data for
+     * @returns The fetched sync block data results
+     */
     fetchSyncBlocksData(syncBlockNodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     private updateCache;
     private updateSourceTitleSubscriptions;
@@ -32,5 +37,6 @@ export declare class ReferenceSyncBlockStoreManager {
      */
     getSyncBlockURL(resourceId: ResourceId): string | undefined;
     getProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
+    private retrieveDynamicProviders;
     destroy(): void;
 }

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

@@ -14,6 +14,7 @@ export declare class SourceSyncBlockStoreManager {
     private pendingResourceId?;
     private creationCallback?;
     constructor(dataProvider?: SyncBlockDataProvider);
+    isSourceBlock(node: PMNode): boolean;
     /**
      * Add/update a sync block node to/from the local cache
      * @param syncBlockNode - The sync block node to update
@@ -24,21 +25,36 @@ export declare class SourceSyncBlockStoreManager {
      *
      * @returns true if saving all nodes successfully, false if fail to save some/all nodes
      */
-    flushBodiedSyncBlocks(): Promise<boolean>;
+    flush(): Promise<boolean>;
     setEditorView(editorView: EditorView | undefined): void;
     registerPendingCreation(resourceId: ResourceId): void;
+    /**
+     * Register callback function (which inserts node, handles focus etc) to be used later when creation to backend succeed
+     */
     registerCreationCallback(callback: CreationCallback): void;
     /**
      *  Fires callback to insert node (if creation is successful) and clears pending creation data
      * @param success
      */
     commitPendingCreation(success: boolean): void;
+    /**
+     *
+     * @returns true if waiting for the result of saving new bodiedSyncBlock to backend
+     */
     hasPendingCreation(): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
+    /**
+     * @returns attributes for a new bodiedSyncBlock node
+     */
     generateBodiedSyncBlockAttrs(): SyncBlockAttrs;
+    /**
+     * Create a bodiedSyncBlock node with empty content to backend
+     * @param attrs attributes Ids of the node
+     */
     createBodiedSyncBlockNode(attrs: SyncBlockAttrs): void;
     private setPendingDeletion;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    destroy(): void;
 }

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

@@ -1,66 +1,11 @@
-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';
-import type { ResourceId, SyncBlockAttrs } from '../common/types';
-import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance, TitleSubscriptionCallback } from '../providers/types';
+import type { SyncBlockDataProvider } from '../providers/types';
 import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
-import { type ConfirmationCallback, type CreationCallback } from './sourceSyncBlockStoreManager';
+import { SourceSyncBlockStoreManager } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
     private sourceSyncBlockStoreManager;
     constructor(dataProvider?: SyncBlockDataProvider);
-    /**
-     * Fetch sync block data for a given array of sync block nodes.
-     * @param nodes - The array of sync block nodes to fetch data for
-     * @returns The fetched sync block data results
-     */
-    fetchSyncBlocksData(nodes: PMNode[]): Promise<SyncBlockInstance[]>;
-    getReferenceSyncBlockStoreManager(): ReferenceSyncBlockStoreManager;
-    /**
-     * Add/update a sync block node to/from the local cache
-     * @param syncBlockNode - The sync block node to update
-     */
-    updateSyncBlockData(syncBlockNode: PMNode): boolean;
-    /**
-     * Save content of bodiedSyncBlock nodes in local cache to backend
-     *
-     * @returns true if saving all nodes successfully, false if fail to save some/all nodes
-     */
-    flushBodiedSyncBlocks(): Promise<boolean>;
-    /**
-     * Get the URL for a sync block.
-     * @param resourceId - The resource ID of the sync block to get the URL for
-     * @returns
-     */
-    getSyncBlockURL(resourceId: ResourceId): string | undefined;
-    setEditorView(editorView: EditorView | undefined): void;
-    isSourceBlock(node: PMNode): boolean;
-    registerConfirmationCallback(callback: ConfirmationCallback): () => void;
-    requireConfirmationBeforeDelete(): boolean;
-    /**
-     * Register callback function (which inserts node, handles focus etc) to be used later when creation to backend succeed
-     */
-    registerCreationCallback(callback: CreationCallback): void;
-    /**
-     *
-     * @returns true if waiting for the result of saving new bodiedSyncBlock to backend
-     */
-    hasPendingCreation(): boolean;
-    /**
-     * @returns attributes for a new bodiedSyncBlock node
-     */
-    generateBodiedSyncBlockAttrs(): SyncBlockAttrs;
-    /**
-     * Save bodiedSyncBlock with empty content to backend
-     * @param attrs attributes Ids of the node
-     */
-    createBodiedSyncBlockNode(attrs: SyncBlockAttrs): void;
-    subscribeToSyncBlockData(node: PMNode, callback: SubscriptionCallback): () => void;
-    subscribeToSyncBlockSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
-    refreshSubscriptions(): void;
-    deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
-    rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
-    getReferenceSyncBlockProviderFactory(resourceId: ResourceId): ProviderFactory | undefined;
+    get referenceManager(): ReferenceSyncBlockStoreManager;
+    get sourceManager(): SourceSyncBlockStoreManager;
     destroy(): void;
 }

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

@@ -1,10 +1,9 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockData, BlockInstanceId, ResourceId, SyncBlockNode } from '../common/types';
-import type { PAGE_TYPE } from './ari';
 export declare const convertSyncBlockPMNodeToSyncBlockData: (node: PMNode) => SyncBlockData;
-export declare const isBlogPageType: (pageType: PAGE_TYPE) => boolean;
 export declare const createSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;
 export declare const createBodiedSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;
 export declare const convertSyncBlockJSONNodeToSyncBlockNode: (node: JSONNode) => SyncBlockNode | undefined;
 export declare const convertPMNodeToSyncBlockNode: (node: PMNode) => SyncBlockNode | undefined;
+export declare const convertPMNodesToSyncBlockNodes: (nodes: PMNode[]) => SyncBlockNode[];

package/package.json

@@ -26,18 +26,18 @@
 	"dependencies": {
 		"@atlaskit/adf-schema": "^51.4.0",
 		"@atlaskit/adf-utils": "^19.26.0",
-		"@atlaskit/css": "^0.15.0",
+		"@atlaskit/css": "^0.16.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
 		"@atlaskit/node-data-provider": "^7.5.0",
-		"@atlaskit/primitives": "^16.1.0",
-		"@atlaskit/tokens": "^8.0.0",
+		"@atlaskit/primitives": "^16.2.0",
+		"@atlaskit/tokens": "^8.1.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.18.6",
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^110.32.0",
+		"@atlaskit/editor-common": "^110.33.0",
 		"react": "^18.2.0"
 	},
 	"devDependencies": {
@@ -83,7 +83,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.10.1",
+	"version": "2.10.3",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

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

@@ -1,9 +0,0 @@
-export type PAGE_TYPE = 'page' | 'blogpost';
-export declare const getConfluencePageAri: (pageId: string, cloudId: string, pageType?: PAGE_TYPE) => string;
-export declare const getPageIdAndTypeFromAri: (ari: string) => {
-    id: string;
-    type: PAGE_TYPE;
-};
-export declare const getLocalIdFromAri: (ari: string) => string;
-export declare const getPageARIFromResourceId: (resourceId: string) => string;
-export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;

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

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

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

@@ -1,9 +0,0 @@
-export type PAGE_TYPE = 'page' | 'blogpost';
-export declare const getConfluencePageAri: (pageId: string, cloudId: string, pageType?: PAGE_TYPE) => string;
-export declare const getPageIdAndTypeFromAri: (ari: string) => {
-    id: string;
-    type: PAGE_TYPE;
-};
-export declare const getLocalIdFromAri: (ari: string) => string;
-export declare const getPageARIFromResourceId: (resourceId: string) => string;
-export declare const resourceIdFromSourceAndLocalId: (sourceId: string, localId: string) => string;

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

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