@atlaskit/editor-synced-block-provider 2.5.2 → 2.7.0

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

@@ -1,15 +1,18 @@
-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';
+import type { ResourceId, SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = () => Promise<boolean>;
+export type CreationCallback = () => void;
 export declare class SourceSyncBlockStoreManager {
     private dataProvider?;
     private editorView?;
     private syncBlockCache;
     private confirmationCallback?;
     private confirmationTransaction?;
+    private pendingResourceId?;
+    private creationCallback?;
     constructor(dataProvider?: SyncBlockDataProvider);
     /**
      * Add/update a sync block node to/from the local cache
@@ -23,9 +26,18 @@ export declare class SourceSyncBlockStoreManager {
      */
     flushBodiedSyncBlocks(): Promise<boolean>;
     setEditorView(editorView: EditorView | undefined): void;
+    registerPendingCreation(resourceId: ResourceId): void;
+    registerCreationCallback(callback: CreationCallback): void;
+    /**
+     *  Fires callback to insert node (if creation is successful) and clears pending creation data
+     * @param success
+     */
+    commitPendingCreation(success: boolean): void;
+    hasPendingCreation(): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
-    createSyncBlockNode(): SyncBlockNode;
+    generateBodiedSyncBlockAttrs(): SyncBlockAttrs;
+    createBodiedSyncBlockNode(attrs: SyncBlockAttrs): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
 }

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

@@ -1,9 +1,10 @@
 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 { ResourceId, SyncBlockAttrs } from '../common/types';
 import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance, TitleSubscriptionCallback } from '../providers/types';
-import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
+import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
+import { type ConfirmationCallback, type CreationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
     private sourceSyncBlockStoreManager;
@@ -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
@@ -35,7 +37,24 @@ export declare class SyncBlockStoreManager {
     isSourceBlock(node: PMNode): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
-    createSyncBlockNode(): SyncBlockNode;
+    /**
+     * 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;

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

@@ -0,0 +1 @@
+export declare const stringifyError: (error: unknown) => string | undefined;

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

@@ -1,5 +1,10 @@
+import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { SyncBlockData } from '../common/types';
+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;

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

@@ -1,14 +1,15 @@
-export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
-export { SyncBlockStoreManager } from './store-manager/syncBlockStoreManager';
-export { useFetchSyncBlockData } from './hooks/useFetchSyncBlockData';
+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 type { SyncBlockData, SyncBlockNode } from './common/types';
-export type { SyncBlockDataProvider, ADFFetchProvider, ADFWriteProvider, SyncBlockInstance, } from './providers/types';
-export { SyncBlockError } from './common/types';
-export { getDefaultSyncBlockSchema } from './common/schema';
 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, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, } from './utils/utils';
 export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';

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 } from '../types';
+import type { ADFFetchProvider, ADFWriteProvider, DeleteSyncBlockResult, SyncBlockInstance, WriteSyncBlockResult } from '../types';
 /**
  * Configuration for Content API providers
  */
@@ -22,7 +22,7 @@ declare class ConfluenceADFWriteProvider implements ADFWriteProvider {
     private config;
     constructor(config: ContentAPIConfig);
     private createNewContentProperty;
-    writeData(data: SyncBlockData): Promise<string>;
+    writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
     deleteData(resourceId: string): Promise<DeleteSyncBlockResult>;
 }
 /**

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 } from '../providers/types';
+import { SyncBlockDataProvider, type ADFFetchProvider, type ADFWriteProvider, type DeleteSyncBlockResult, type SyncBlockInstance, type SyncBlockSourceInfo, type WriteSyncBlockResult } from '../providers/types';
 export declare class SyncBlockProvider extends SyncBlockDataProvider {
     name: string;
     private fetchProvider;
@@ -15,9 +15,10 @@ export declare class SyncBlockProvider extends SyncBlockDataProvider {
      * @param nodes
      * @param data
      *
-     * @returns the resource ids of the nodes that were written
+     * @returns Array of {resourceId?: string, error?: string}.
+     * resourceId: resource id of the node if write successfully , error: reason for when write failed
      */
-    writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<string | undefined>>;
+    writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     getSourceId(): string;
     retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;

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

@@ -19,15 +19,19 @@ export type SyncBlockSourceInfo = {
     title?: string;
     url?: string;
 };
+export type WriteSyncBlockResult = {
+    error?: string;
+    resourceId?: string;
+};
 export interface ADFFetchProvider {
     fetchData: (resourceId: ResourceId) => Promise<SyncBlockInstance>;
 }
 export interface ADFWriteProvider {
     deleteData: (resourceId: string) => Promise<DeleteSyncBlockResult>;
-    writeData: (data: SyncBlockData) => Promise<string>;
+    writeData: (data: SyncBlockData) => Promise<WriteSyncBlockResult>;
 }
 export declare abstract class SyncBlockDataProvider extends NodeDataProvider<SyncBlockNode, SyncBlockInstance> {
-    abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<ResourceId | undefined>>;
+    abstract writeNodesData(nodes: SyncBlockNode[], data: SyncBlockData[]): Promise<Array<WriteSyncBlockResult>>;
     abstract deleteNodesData(resourceIds: string[]): Promise<Array<DeleteSyncBlockResult>>;
     abstract getSourceId(): ResourceId;
     abstract retrieveSyncBlockSourceUrlAndTitle(node: SyncBlockNode): Promise<SyncBlockSourceInfo | undefined>;

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

@@ -20,8 +20,9 @@ export declare class ReferenceSyncBlockStoreManager {
     private updateSourceTitleSubscriptions;
     private getFromCache;
     private deleteFromCache;
-    subscribe(node: PMNode, callback: SubscriptionCallback): () => void;
+    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.
      * @param resourceId - The resource ID of the sync block

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

@@ -1,15 +1,18 @@
-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';
+import type { ResourceId, SyncBlockAttrs } from '../common/types';
 import type { SyncBlockDataProvider } from '../providers/types';
 export type ConfirmationCallback = () => Promise<boolean>;
+export type CreationCallback = () => void;
 export declare class SourceSyncBlockStoreManager {
     private dataProvider?;
     private editorView?;
     private syncBlockCache;
     private confirmationCallback?;
     private confirmationTransaction?;
+    private pendingResourceId?;
+    private creationCallback?;
     constructor(dataProvider?: SyncBlockDataProvider);
     /**
      * Add/update a sync block node to/from the local cache
@@ -23,9 +26,18 @@ export declare class SourceSyncBlockStoreManager {
      */
     flushBodiedSyncBlocks(): Promise<boolean>;
     setEditorView(editorView: EditorView | undefined): void;
+    registerPendingCreation(resourceId: ResourceId): void;
+    registerCreationCallback(callback: CreationCallback): void;
+    /**
+     *  Fires callback to insert node (if creation is successful) and clears pending creation data
+     * @param success
+     */
+    commitPendingCreation(success: boolean): void;
+    hasPendingCreation(): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
-    createSyncBlockNode(): SyncBlockNode;
+    generateBodiedSyncBlockAttrs(): SyncBlockAttrs;
+    createBodiedSyncBlockNode(attrs: SyncBlockAttrs): void;
     deleteSyncBlocksWithConfirmation(tr: Transaction, syncBlockIds: SyncBlockAttrs[]): Promise<void>;
     rebaseTransaction(incomingTr: Transaction, state: EditorState): void;
 }

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

@@ -1,9 +1,10 @@
 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 { ResourceId, SyncBlockAttrs } from '../common/types';
 import type { SubscriptionCallback, SyncBlockDataProvider, SyncBlockInstance, TitleSubscriptionCallback } from '../providers/types';
-import { type ConfirmationCallback } from './sourceSyncBlockStoreManager';
+import { ReferenceSyncBlockStoreManager } from './referenceSyncBlockStoreManager';
+import { type ConfirmationCallback, type CreationCallback } from './sourceSyncBlockStoreManager';
 export declare class SyncBlockStoreManager {
     private referenceSyncBlockStoreManager;
     private sourceSyncBlockStoreManager;
@@ -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
@@ -35,7 +37,24 @@ export declare class SyncBlockStoreManager {
     isSourceBlock(node: PMNode): boolean;
     registerConfirmationCallback(callback: ConfirmationCallback): () => void;
     requireConfirmationBeforeDelete(): boolean;
-    createSyncBlockNode(): SyncBlockNode;
+    /**
+     * 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;

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

@@ -0,0 +1 @@
+export declare const stringifyError: (error: unknown) => string | undefined;

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

@@ -1,5 +1,10 @@
+import type { JSONNode } from '@atlaskit/editor-json-transformer';
 import type { Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { SyncBlockData } from '../common/types';
+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;

package/package.json

@@ -29,7 +29,7 @@
 		"@atlaskit/css": "^0.15.0",
 		"@atlaskit/editor-json-transformer": "^8.31.0",
 		"@atlaskit/editor-prosemirror": "7.0.0",
-		"@atlaskit/node-data-provider": "^7.4.0",
+		"@atlaskit/node-data-provider": "^7.5.0",
 		"@atlaskit/primitives": "^16.1.0",
 		"@atlaskit/tokens": "^7.1.0",
 		"@babel/runtime": "^7.0.0",
@@ -82,7 +82,7 @@
 		}
 	},
 	"name": "@atlaskit/editor-synced-block-provider",
-	"version": "2.5.2",
+	"version": "2.7.0",
 	"description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/dist/cjs/utils/createSyncBlock.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createSyncBlockNode = void 0;
-var createSyncBlockNode = exports.createSyncBlockNode = function createSyncBlockNode(localId, resourceId) {
-  return {
-    type: 'syncBlock',
-    attrs: {
-      localId: localId,
-      resourceId: resourceId
-    }
-  };
-};

package/dist/es2019/utils/createSyncBlock.js

@@ -1,9 +0,0 @@
-export const createSyncBlockNode = (localId, resourceId) => {
-  return {
-    type: 'syncBlock',
-    attrs: {
-      localId,
-      resourceId
-    }
-  };
-};

package/dist/esm/utils/createSyncBlock.js

@@ -1,9 +0,0 @@
-export var createSyncBlockNode = function createSyncBlockNode(localId, resourceId) {
-  return {
-    type: 'syncBlock',
-    attrs: {
-      localId: localId,
-      resourceId: resourceId
-    }
-  };
-};

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

@@ -1,2 +0,0 @@
-import type { BlockInstanceId, ResourceId, SyncBlockNode } from '../common/types';
-export declare const createSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;

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

@@ -1,2 +0,0 @@
-import type { BlockInstanceId, ResourceId, SyncBlockNode } from '../common/types';
-export declare const createSyncBlockNode: (localId: BlockInstanceId, resourceId: ResourceId) => SyncBlockNode;