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

package/dist/esm/utils/mergeFetchSyncBlockDataResult.js

@@ -0,0 +1,31 @@
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+/**
+ * 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 var resolveFetchSyncBlockDataResult = function resolveFetchSyncBlockDataResult(oldResult, newResult) {
+  var _newResult$data, _oldResult$data;
+  // if the old result has no data, we simple return the new result
+  if (!oldResult.data) {
+    return newResult;
+  } else if (!newResult.data) {
+    // if the new result has no data, we simply return the old result
+    // TODO: EDITOR-2533 - handle this case based on the error type and whether we should keep old data or not
+    return oldResult;
+  }
+
+  // otherwise, we merge the two results, preserving the sourceURL from the old result if it exists
+  return _objectSpread(_objectSpread({}, newResult), {}, {
+    data: _objectSpread(_objectSpread({}, newResult.data), {}, {
+      sourceURL: ((_newResult$data = newResult.data) === null || _newResult$data === void 0 ? void 0 : _newResult$data.sourceURL) || ((_oldResult$data = oldResult.data) === null || _oldResult$data === void 0 ? void 0 : _oldResult$data.sourceURL) || undefined
+    })
+  });
+};

package/dist/types/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/providers/confluence/confluenceContentAPI.d.ts

@@ -1,5 +1,5 @@
 import { type SyncBlockData } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, FetchSyncBlockDataResult } from '../types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, FetchSyncBlockDataResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -23,6 +23,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     constructor(config: ContentAPIConfig);
     private createNewContentProperty;
     writeData(data: SyncBlockData): Promise<string>;
+    deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
 }
 /**
  * Convenience function to create providers with default content property key

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

@@ -1,6 +1,6 @@
 import type { JSONNode } from '@atlaskit/editor-json-transformer/types';
-import type { SyncBlockData, SyncBlockNode } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type FetchSyncBlockDataResult } from '../providers/types';
+import { type SyncBlockData, type SyncBlockNode } from '../common/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type FetchSyncBlockDataResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -18,6 +18,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @returns the resource ids of the nodes that were written
      */
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
+    deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
     retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
 }

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

@@ -5,14 +5,22 @@ export type FetchSyncBlockDataResult = {
     error?: SyncBlockError;
     resourceId?: string;
 };
+export type DeleteSyncBlockResult = {
+    error?: string;
+    resourceId: string;
+    success: boolean;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<FetchSyncBlockDataResult>;
 }
 export interface ADFWriteProvider {
+    deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
     writeData: (data: SyncBlockData) => Promise<string>;
 }
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, FetchSyncBlockDataResult> {
     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>;
 }
+export type SubscriptionCallback = (data: FetchSyncBlockDataResult) => void;

package/dist/types/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/store-manager/sourceSyncBlockStoreManager.d.ts

@@ -1,4 +1,4 @@
-import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { SyncBlockAttrs, SyncBlockNode } from '../common/types';

package/dist/types/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/utils/contentProperty.d.ts

@@ -22,6 +22,12 @@ type UpdateContentPropertyOptions = {
     signal?: AbortSignal;
     value: SyncBlockData;
 };
+type DeleteContentPropertyOptions = {
+    cloudId: string;
+    key: string;
+    pageId: string;
+    pageType: PAGE_TYPE;
+};
 export type GetContentPropertyResult = {
     data: {
         confluence: {
@@ -98,7 +104,36 @@ export type CreateBlogPostContentPropertyResult = {
         };
     };
 };
+export type DeletePageContentPropertyResult = {
+    data: {
+        confluence: {
+            deletePageProperty: {
+                errors: [
+                    {
+                        message: string;
+                    }
+                ];
+                success: boolean;
+            };
+        };
+    };
+};
+export type DeleteBlogPostPropertyResult = {
+    data: {
+        confluence: {
+            deleteBlogPostProperty: {
+                errors: [
+                    {
+                        message: string;
+                    }
+                ];
+                success: boolean;
+            };
+        };
+    };
+};
 export declare const getContentProperty: <T extends GetContentPropertyResult | GetBlogPostContentPropertyResult>({ pageId, key, cloudId, pageType, }: GetContentPropertyOptions) => Promise<T>;
 export declare const updateContentProperty: <T extends UpdateContentPropertyResult | UpdateBlogPostContentPropertyResult>({ pageId, key, value, cloudId, pageType, }: UpdateContentPropertyOptions) => Promise<T>;
 export declare const createContentProperty: <T extends CreateContentPropertyResult | CreateBlogPostContentPropertyResult>({ pageId, key, value, cloudId, pageType, }: CreateContentPropertyOptions) => Promise<T>;
+export declare const deleteContentProperty: <T extends DeletePageContentPropertyResult | DeleteBlogPostPropertyResult>({ pageId, cloudId, pageType, key, }: DeleteContentPropertyOptions) => Promise<T>;
 export {};

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/confluence/confluenceContentAPI.d.ts

@@ -1,5 +1,5 @@
 import { type SyncBlockData } from '../../common/types';
-import type { ADFFetchProvider, ADFWriteProvider, FetchSyncBlockDataResult } from '../types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, FetchSyncBlockDataResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -23,6 +23,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     constructor(config: ContentAPIConfig);
     private createNewContentProperty;
     writeData(data: SyncBlockData): Promise<string>;
+    deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
 }
 /**
  * Convenience function to create providers with default content property key

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, SyncBlockNode } from '../common/types';
-import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type FetchSyncBlockDataResult } from '../providers/types';
+import { type SyncBlockData, type SyncBlockNode } from '../common/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type FetchSyncBlockDataResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -18,6 +18,7 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @returns the resource ids of the nodes that were written
      */
     writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
+    deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
     retrieveSyncBlockSourceUrl(node: SyncBlockNode): Promise<string | undefined>;
 }

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

@@ -5,14 +5,22 @@ export type FetchSyncBlockDataResult = {
     error?: SyncBlockError;
     resourceId?: string;
 };
+export type DeleteSyncBlockResult = {
+    error?: string;
+    resourceId: string;
+    success: boolean;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<FetchSyncBlockDataResult>;
 }
 export interface ADFWriteProvider {
+    deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
     writeData: (data: SyncBlockData) => Promise<string>;
 }
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, FetchSyncBlockDataResult> {
     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>;
 }
+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/sourceSyncBlockStoreManager.d.ts

@@ -1,4 +1,4 @@
-import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
+import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
 import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { SyncBlockAttrs, SyncBlockNode } from '../common/types';

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/contentProperty.d.ts

@@ -22,6 +22,12 @@ type UpdateContentPropertyOptions = {
     signal?: AbortSignal;
     value: SyncBlockData;
 };
+type DeleteContentPropertyOptions = {
+    cloudId: string;
+    key: string;
+    pageId: string;
+    pageType: PAGE_TYPE;
+};
 export type GetContentPropertyResult = {
     data: {
         confluence: {
@@ -98,7 +104,36 @@ export type CreateBlogPostContentPropertyResult = {
         };
     };
 };
+export type DeletePageContentPropertyResult = {
+    data: {
+        confluence: {
+            deletePageProperty: {
+                errors: [
+                    {
+                        message: string;
+                    }
+                ];
+                success: boolean;
+            };
+        };
+    };
+};
+export type DeleteBlogPostPropertyResult = {
+    data: {
+        confluence: {
+            deleteBlogPostProperty: {
+                errors: [
+                    {
+                        message: string;
+                    }
+                ];
+                success: boolean;
+            };
+        };
+    };
+};
 export declare const getContentProperty: <T extends GetContentPropertyResult | GetBlogPostContentPropertyResult>({ pageId, key, cloudId, pageType, }: GetContentPropertyOptions) => Promise<T>;
 export declare const updateContentProperty: <T extends UpdateContentPropertyResult | UpdateBlogPostContentPropertyResult>({ pageId, key, value, cloudId, pageType, }: UpdateContentPropertyOptions) => Promise<T>;
 export declare const createContentProperty: <T extends CreateContentPropertyResult | CreateBlogPostContentPropertyResult>({ pageId, key, value, cloudId, pageType, }: CreateContentPropertyOptions) => Promise<T>;
+export declare const deleteContentProperty: <T extends DeletePageContentPropertyResult | DeleteBlogPostPropertyResult>({ pageId, cloudId, pageType, key, }: DeleteContentPropertyOptions) => Promise<T>;
 export {};

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.1",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",