@atlaskit/editor-synced-block-provider 2.5.1 → 2.6.0

package/dist/types/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 } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -20,6 +20,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
-    retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;

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

@@ -15,6 +15,10 @@ export type DeleteSyncBlockResult = {
     resourceId: string;
     success: boolean;
 };
+export type SyncBlockSourceInfo = {
+    title?: string;
+    url?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
@@ -26,6 +30,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<ResourceId | undefined>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
-    abstract retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    abstract retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
+export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -1,10 +1,11 @@
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { ResourceId, SyncBlockNode } from '../common/types';
-import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider } from '../providers/types';
+import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
 export declare class ReferenceSyncBlockStoreManager {
     private dataProvider?;
     private syncBlockCache;
     private subscriptions;
+    private titleSubscriptions;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -13,11 +14,14 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns {Promise<void>}
      */
     refreshSubscriptions(): Promise<void>;
-    private fetchSyncBlockSourceURL;
+    private fetchSyncBlockSourceURLAndTitle;
     fetchSyncBlocksData(syncBlockNodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     private updateCache;
+    private updateSourceTitleSubscriptions;
     private getFromCache;
     private deleteFromCache;
+    subscribeToSyncBlock(resourceId: string, localId: string, callback: SubscriptionCallback): () => void;
+    subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
     subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
     /**
      * Get the URL for a sync block.

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

@@ -2,7 +2,8 @@ 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, SyncBlockNode } from '../common/types';
-import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance } from '../providers/types';
+import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance, TitleSubscriptionCallback } from '../providers/types';
+import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
 import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
@@ -14,6 +15,7 @@ export declare class SyncBlockStoreManager {
      * @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
@@ -37,6 +39,7 @@ export declare class SyncBlockStoreManager {
     requireConfirmationBeforeDelete(): boolean;
     createSyncBlockNode(): SyncBlockNode;
     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;

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

@@ -3,4 +3,4 @@
  * Otherwise we could import defaultSchemaConfig from '@atlaskit/adf-schema/schema-default';
  * @returns
  */
-export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"status" | "doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;
+export declare const getDefaultSyncBlockSchema: () => import("prosemirror-model").Schema<"doc" | "paragraph" | "text" | "bulletList" | "orderedList" | "listItem" | "heading" | "blockquote" | "codeBlock" | "panel" | "rule" | "expand" | "nestedExpand" | "table" | "tableCell" | "tableHeader" | "tableRow" | "date" | "status" | "layoutSection" | "layoutColumn" | "unsupportedBlock" | "unsupportedInline", "link" | "em" | "strong" | "strike" | "subsup" | "underline" | "code" | "textColor" | "backgroundColor" | "alignment" | "indentation" | "border" | "unsupportedMark" | "unsupportedNodeAttribute" | "typeAheadQuery">;

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

@@ -24,6 +24,7 @@ export interface SyncBlockData {
     isSynced?: boolean;
     resourceId: ResourceId;
     sourceDocumentAri?: string;
+    sourceTitle?: string;
     sourceURL?: string;
     updatedAt?: string;
 }

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

@@ -1,5 +1,8 @@
-import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { SyncBlockInstance } from '../providers/types';
 import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
-export declare const SYNC_BLOCK_FETCH_INTERVAL = 3000;
-export declare const useFetchSyncBlockData: (manager: SyncBlockStoreManager, syncBlockNode: PMNode) => SyncBlockInstance | null;
+export interface UseFetchSyncBlockDataResult {
+    isLoading: boolean;
+    reloadData: () => Promise<void>;
+    syncBlockInstance: SyncBlockInstance | null;
+}
+export declare const useFetchSyncBlockData: (manager: SyncBlockStoreManager, resourceId?: string, localId?: string) => UseFetchSyncBlockDataResult;

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

@@ -0,0 +1,3 @@
+import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { SyncBlockStoreManager } from '../store-manager/syncBlockStoreManager';
+export declare const useFetchSyncBlockTitle: (manager: SyncBlockStoreManager, syncBlockNode: PMNode) => string | undefined;

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

@@ -1,13 +1,16 @@
-export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
-export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
-export { useHandleContentChanges } from './hooks/useHandleContentChanges';
-export type { SyncBlockData, SyncBlockNode } from './common/types';
-export type { SyncBlockDataProvider, ADFFetchProvider, ADFWriteProvider, SyncBlockInstance, } from './providers/types';
-export { SyncBlockError } from './common/types';
+export { rebaseTransaction } from './common/rebase-transaction';
 export { getDefaultSyncBlockSchema } from './common/schema';
+export { SyncBlockError } from './common/types';
+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 { 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 { getConfluencePageAri, getPageIdAndTypeFromAri } from './utils/ari';
-export { convertSyncBlockPMNodeToSyncBlockData } from './utils/utils';
-export { rebaseTransaction } from './common/rebase-transaction';
+export { createSyncBlockNode } from './utils/createSyncBlock';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
+export { convertSyncBlockPMNodeToSyncBlockData } 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 } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -20,6 +20,6 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
-    retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export declare const useMemoizedSyncedBlockProvider: (fetchProvider: ADFFetchProvider, writeProvider: ADFWriteProvider, sourceId: string) => SyncBlockProvider;

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

@@ -15,6 +15,10 @@ export type DeleteSyncBlockResult = {
     resourceId: string;
     success: boolean;
 };
+export type SyncBlockSourceInfo = {
+    title?: string;
+    url?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
@@ -26,6 +30,7 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<ResourceId | undefined>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
-    abstract retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
+    abstract retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;
 }
 export type SubscriptionCallback = (data: SyncBlockInstance) => void;
+export type TitleSubscriptionCallback = (title: string) => void;

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

@@ -1,10 +1,11 @@
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { ResourceId, SyncBlockNode } from '../common/types';
-import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider } from '../providers/types';
+import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback } from '../providers/types';
 export declare class ReferenceSyncBlockStoreManager {
     private dataProvider?;
     private syncBlockCache;
     private subscriptions;
+    private titleSubscriptions;
     private syncBlockURLRequests;
     private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
@@ -13,11 +14,14 @@ export declare class ReferenceSyncBlockStoreManager {
      * @returns {Promise<void>}
      */
     refreshSubscriptions(): Promise<void>;
-    private fetchSyncBlockSourceURL;
+    private fetchSyncBlockSourceURLAndTitle;
     fetchSyncBlocksData(syncBlockNodes: SyncBlockNode[]): Promise<SyncBlockInstance[]>;
     private updateCache;
+    private updateSourceTitleSubscriptions;
     private getFromCache;
     private deleteFromCache;
+    subscribeToSyncBlock(resourceId: string, localId: string, callback: SubscriptionCallback): () => void;
+    subscribeToSourceTitle(node: PMNode, callback: TitleSubscriptionCallback): () => void;
     subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
     /**
      * Get the URL for a sync block.

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

@@ -2,7 +2,8 @@ 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, SyncBlockNode } from '../common/types';
-import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance } from '../providers/types';
+import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance, TitleSubscriptionCallback } from '../providers/types';
+import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
 import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
@@ -14,6 +15,7 @@ export declare class SyncBlockStoreManager {
      * @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
@@ -37,6 +39,7 @@ export declare class SyncBlockStoreManager {
     requireConfirmationBeforeDelete(): boolean;
     createSyncBlockNode(): SyncBlockNode;
     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;

package/package.json

@@ -82,7 +82,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.5.1",
+	"version": "2.6.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",