@atlaskit/editor-synced-block-provider 2.2.3 → 2.3.0

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

@@ -0,0 +1,12 @@
+import type { FetchSyncBlockDataResult } from '../providers/types';
+/**
+ * Merges two FetchSyncBlockDataResult objects,
+ * currently it only preserves the sourceURL from the old result,
+ * but this can be extended in the future to preserve other fields and resolve conflicts as needed.
+ * e.g. compare timestamps or version numbers to determine which data is more recent.
+ *
+ * @param oldResult - The existing FetchSyncBlockDataResult object.
+ * @param newResult - The new FetchSyncBlockDataResult object to merge.
+ * @returns A merged FetchSyncBlockDataResult object.
+ */
+export declare const resolveFetchSyncBlockDataResult: (oldResult: FetchSyncBlockDataResult, newResult: FetchSyncBlockDataResult) => FetchSyncBlockDataResult;

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<"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">;
+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">;

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

@@ -1,5 +1,5 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import type { SyncBlockData, SyncBlockNode } from '../common/types';
+import { type SyncBlockData, type SyncBlockNode } from '../common/types';
 import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type FetchSyncBlockDataResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;

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

@@ -16,3 +16,4 @@ export declare abstract class SyncBlockDataProvider extends NodeDataProvider<Syn
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
 }
+export type SubscriptionCallback = (data: FetchSyncBlockDataResult) => void;

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

@@ -1,23 +1,39 @@
 import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { BlockInstanceId } from '../common/types';
-import type { FetchSyncBlockDataResult, SyncBlockDataProvider } from '../providers/types';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
+import type { ResourceId, SyncBlockNode } from '../common/types';
+import type { FetchSyncBlockDataResult, SubscriptionCallback, SyncBlockDataProvider } from '../providers/types';
 export declare class ReferenceSyncBlockStoreManager {
     private dataProvider?;
     private syncBlockCache;
+    private subscriptions;
     private syncBlockURLRequests;
+    private editorView?;
+    private isInitialized;
+    private isRefreshingSubscriptions;
     constructor(dataProvider?: SyncBlockDataProvider);
+    init(editorView: EditorView): Promise<void>;
     /**
-     *
-     * @param localId - The local ID of the sync block to get the source URL for
-     * @param resourceId - The resource ID of the sync block to get the source URL for
-     * Fetches source URl for a sync block and updates sync block data with the source URL asynchronously.
+     * Refreshes the subscriptions for all sync blocks.
+     * @returns {Promise<void>}
      */
+    refreshSubscriptions(): Promise<void>;
     private fetchSyncBlockSourceURL;
+    /**
+     * Fetch sync block data for a given sync block node.
+     * @param syncBlockNode - The sync block node to fetch data for
+     * @returns The fetched sync block data result
+     */
     fetchSyncBlockData(syncBlockNode: PMNode): Promise<FetchSyncBlockDataResult>;
+    fetchSyncBlocksData(syncBlockNodes: SyncBlockNode[]): Promise<FetchSyncBlockDataResult[]>;
+    private updateCache;
+    private getFromCache;
+    private deleteFromCache;
+    subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
     /**
      * Get the URL for a sync block.
-     * @param localId - The local ID of the sync block to get the URL for
+     * @param resourceId - The resource ID of the sync block
      * @returns
      */
-    getSyncBlockURL(localId: BlockInstanceId): string | undefined;
+    getSyncBlockURL(resourceId: ResourceId): string | undefined;
+    destroy(): void;
 }

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

@@ -1,13 +1,18 @@
 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 { BlockInstanceId, SyncBlockAttrs, SyncBlockNode } from '../common/types';
-import type { FetchSyncBlockDataResult, SyncBlockDataProvider } from '../providers/types';
+import type { ResourceId, SyncBlockAttrs, SyncBlockNode } from '../common/types';
+import type { FetchSyncBlockDataResult, SubscriptionCallback, SyncBlockDataProvider } from '../providers/types';
 import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
     private sourceSyncBlockStoreManager;
     constructor(dataProvider?: SyncBlockDataProvider);
+    /**
+     * Fetch sync block data for a given sync block node.
+     * @param syncBlockNode - The sync block node to fetch data for
+     * @returns The fetched sync block data result
+     */
     fetchSyncBlockData(syncBlockNode: PMNode): Promise<FetchSyncBlockDataResult | undefined>;
     /**
      * Add/update a sync block node to/from the local cache
@@ -22,15 +27,18 @@ export declare class SyncBlockStoreManager {
     flushBodiedSyncBlocks(): Promise<boolean>;
     /**
      * Get the URL for a sync block.
-     * @param localId - The local ID of the sync block to get the URL for
+     * @param resourceId - The resource ID of the sync block to get the URL for
      * @returns
      */
-    getSyncBlockURL(localId: BlockInstanceId): string | undefined;
+    getSyncBlockURL(resourceId: ResourceId): string | undefined;
     setEditorView(editorView: EditorView | undefined): void;
     isSourceBlock(node: PMNode): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
     createSyncBlockNode(): SyncBlockNode;
+    subscribeToSyncBlockData(node: PMNode, callback: SubscriptionCallback): () => void;
+    refreshSubscriptions(): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
+    destroy(): void;
 }

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

@@ -0,0 +1,12 @@
+import type { FetchSyncBlockDataResult } from '../providers/types';
+/**
+ * Merges two FetchSyncBlockDataResult objects,
+ * currently it only preserves the sourceURL from the old result,
+ * but this can be extended in the future to preserve other fields and resolve conflicts as needed.
+ * e.g. compare timestamps or version numbers to determine which data is more recent.
+ *
+ * @param oldResult - The existing FetchSyncBlockDataResult object.
+ * @param newResult - The new FetchSyncBlockDataResult object to merge.
+ * @returns A merged FetchSyncBlockDataResult object.
+ */
+export declare const resolveFetchSyncBlockDataResult: (oldResult: FetchSyncBlockDataResult, newResult: FetchSyncBlockDataResult) => FetchSyncBlockDataResult;

package/package.json

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