@atlaskit/editor-synced-block-provider 3.28.0 → 3.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (28) hide show
  1. package/CHANGELOG.md +19 -0
  2. package/dist/cjs/clients/block-service/blockService.js +118 -310
  3. package/dist/cjs/clients/confluence/sourceInfo.js +19 -37
  4. package/dist/cjs/providers/block-service/blockServiceAPI.js +8 -18
  5. package/dist/cjs/store-manager/referenceSyncBlockStoreManager.js +20 -68
  6. package/dist/cjs/store-manager/sourceSyncBlockStoreManager.js +29 -84
  7. package/dist/cjs/store-manager/syncBlockStoreManager.js +1 -2
  8. package/dist/es2019/clients/block-service/blockService.js +119 -235
  9. package/dist/es2019/clients/confluence/sourceInfo.js +5 -15
  10. package/dist/es2019/providers/block-service/blockServiceAPI.js +8 -18
  11. package/dist/es2019/store-manager/referenceSyncBlockStoreManager.js +34 -80
  12. package/dist/es2019/store-manager/sourceSyncBlockStoreManager.js +40 -90
  13. package/dist/es2019/store-manager/syncBlockStoreManager.js +1 -2
  14. package/dist/esm/clients/block-service/blockService.js +118 -310
  15. package/dist/esm/clients/confluence/sourceInfo.js +19 -37
  16. package/dist/esm/providers/block-service/blockServiceAPI.js +8 -18
  17. package/dist/esm/store-manager/referenceSyncBlockStoreManager.js +20 -68
  18. package/dist/esm/store-manager/sourceSyncBlockStoreManager.js +29 -84
  19. package/dist/esm/store-manager/syncBlockStoreManager.js +1 -2
  20. package/dist/types/clients/block-service/blockService.d.ts +3 -6
  21. package/dist/types/providers/block-service/blockServiceAPI.d.ts +2 -5
  22. package/dist/types/store-manager/referenceSyncBlockStoreManager.d.ts +0 -2
  23. package/dist/types/store-manager/sourceSyncBlockStoreManager.d.ts +0 -14
  24. package/dist/types-ts4.5/clients/block-service/blockService.d.ts +3 -6
  25. package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts +2 -5
  26. package/dist/types-ts4.5/store-manager/referenceSyncBlockStoreManager.d.ts +0 -2
  27. package/dist/types-ts4.5/store-manager/sourceSyncBlockStoreManager.d.ts +0 -14
  28. package/package.json +2 -5
@@ -67,7 +67,6 @@ export declare const isBlockContentResponse: (response: BlockContentResponse | E
67
67
  export declare const getReferenceSyncedBlocks: (documentAri: string) => Promise<ReferenceSyncedBlockResponse>;
68
68
  export type GetSyncedBlockContentRequest = {
69
69
  blockAri: string;
70
- documentAri?: string;
71
70
  };
72
71
  export type DeleteSyncedBlockRequest = {
73
72
  blockAri: string;
@@ -99,7 +98,6 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
99
98
  };
100
99
  export type BatchRetrieveSyncedBlocksRequest = {
101
100
  blockIdentifiers: BlockIdentifier[];
102
- documentAri: string;
103
101
  };
104
102
  type BlockIdentifier = {
105
103
  blockAri: string;
@@ -125,13 +123,12 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
125
123
  /**
126
124
  * Batch retrieves multiple synced blocks by their ARIs.
127
125
  *
128
- * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
129
- * or GraphQL query `blockService_batchRetrieveBlocks` when feature flag is enabled
126
+ * Calls the Block Service GraphQL API: `blockService_batchRetrieveBlocks`
130
127
  *
131
- * @param blockAris - Array of block ARIs to retrieve
128
+ * @param blockIdentifiers - Array of block identifiers to retrieve
132
129
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
133
130
  */
134
- export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, documentAri, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
131
+ export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
135
132
  export declare const deleteSyncedBlock: ({ blockAri, deleteReason, }: DeleteSyncedBlockRequest) => Promise<void>;
136
133
  export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, status, }: UpdateSyncedBlockRequest) => Promise<void>;
137
134
  export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
@@ -64,7 +64,6 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
64
64
  interface BlockServiceADFWriteProviderProps {
65
65
  cloudId: string;
66
66
  getVersion?: () => Promise<number | undefined>;
67
- isParentUnpublished?: () => boolean;
68
67
  parentAri: string | undefined;
69
68
  parentId?: string;
70
69
  product: SyncBlockProduct;
@@ -76,10 +75,9 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
76
75
  private cloudId;
77
76
  private parentId?;
78
77
  private getVersion?;
79
- private isParentUnpublished?;
80
78
  product: SyncBlockProduct;
81
79
  parentAri: string | undefined;
82
- constructor({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: BlockServiceADFWriteProviderProps);
80
+ constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
83
81
  writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
84
82
  createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
85
83
  deleteData(resourceId: string, deleteReason: string | undefined): Promise<DeleteSyncBlockResult>;
@@ -90,12 +88,11 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
90
88
  interface BlockServiceAPIProvidersProps {
91
89
  cloudId: string;
92
90
  getVersion?: () => Promise<number | undefined>;
93
- isParentUnpublished?: () => boolean;
94
91
  parentAri: string | undefined;
95
92
  parentId?: string;
96
93
  product: SyncBlockProduct;
97
94
  }
98
- export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: BlockServiceAPIProvidersProps) => {
95
+ export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
99
96
  fetchProvider: BlockServiceADFFetchProvider;
100
97
  writeProvider: BlockServiceADFWriteProvider;
101
98
  };
@@ -6,14 +6,12 @@ import { type ResourceId, type SyncBlockNode, type SyncBlockPrefetchData } from
6
6
  import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback, SyncBlockSourceInfo } from '../providers/types';
7
7
  export declare class ReferenceSyncBlockStoreManager {
8
8
  private dataProvider?;
9
- private syncBlockCache;
10
9
  private isCacheDirty;
11
10
  private subscriptions;
12
11
  private titleSubscriptions;
13
12
  private providerFactories;
14
13
  private fireAnalyticsEvent?;
15
14
  private syncBlockFetchDataRequests;
16
- private syncBlockSourceInfoRequestsOld;
17
15
  private syncBlockSourceInfoRequests;
18
16
  private isRefreshingSubscriptions;
19
17
  private pendingCacheDeletions;
@@ -6,15 +6,12 @@ export type ConfirmationCallback = (syncBlockIds: SyncBlockAttrs[], deleteReason
6
6
  type OnDelete = () => void;
7
7
  type OnCompletion = (success: boolean) => void;
8
8
  type DestroyCallback = () => void;
9
- export type CreationCallback = () => void;
10
9
  export declare class SourceSyncBlockStoreManager {
11
10
  private dataProvider?;
12
11
  private fireAnalyticsEvent?;
13
12
  private syncBlockCache;
14
13
  private confirmationCallback?;
15
14
  private deletionRetryInfo?;
16
- private pendingResourceId?;
17
- private creationCallback?;
18
15
  private creationCompletionCallbacks;
19
16
  private createExperience;
20
17
  private saveExperience;
@@ -34,23 +31,12 @@ export declare class SourceSyncBlockStoreManager {
34
31
  * @returns true if saving all nodes successfully, false if fail to save some/all nodes
35
32
  */
36
33
  flush(): Promise<boolean>;
37
- registerPendingCreation(resourceId: ResourceId): void;
38
34
  isPendingCreation(resourceId: ResourceId): boolean;
39
- /**
40
- * Register callback function (which inserts node, handles focus etc) to be used later when creation to backend succeed
41
- */
42
- registerCreationCallback(callback: CreationCallback): void;
43
35
  /**
44
36
  * Fires callback to insert node (if creation is successful) and clears pending creation data
45
37
  * @param success
46
38
  */
47
39
  commitPendingCreation(success: boolean, resourceId: ResourceId): void;
48
- /**
49
- *
50
- * @returns true if waiting for the result of saving new bodiedSyncBlock to backend
51
- * Remove this method when cleaning up platform_synced_block_patch_1
52
- */
53
- hasPendingCreation(): boolean;
54
40
  registerConfirmationCallback(callback: ConfirmationCallback): () => void;
55
41
  requireConfirmationBeforeDelete(): boolean;
56
42
  /**
@@ -67,7 +67,6 @@ export declare const isBlockContentResponse: (response: BlockContentResponse | E
67
67
  export declare const getReferenceSyncedBlocks: (documentAri: string) => Promise<ReferenceSyncedBlockResponse>;
68
68
  export type GetSyncedBlockContentRequest = {
69
69
  blockAri: string;
70
- documentAri?: string;
71
70
  };
72
71
  export type DeleteSyncedBlockRequest = {
73
72
  blockAri: string;
@@ -99,7 +98,6 @@ type UpdateReferenceSyncedBlockOnDocumentRequest = {
99
98
  };
100
99
  export type BatchRetrieveSyncedBlocksRequest = {
101
100
  blockIdentifiers: BlockIdentifier[];
102
- documentAri: string;
103
101
  };
104
102
  type BlockIdentifier = {
105
103
  blockAri: string;
@@ -125,13 +123,12 @@ export declare const getSyncedBlockContent: ({ blockAri, }: GetSyncedBlockConten
125
123
  /**
126
124
  * Batch retrieves multiple synced blocks by their ARIs.
127
125
  *
128
- * Calls the Block Service API endpoint: `POST /v1/block/batch-retrieve`
129
- * or GraphQL query `blockService_batchRetrieveBlocks` when feature flag is enabled
126
+ * Calls the Block Service GraphQL API: `blockService_batchRetrieveBlocks`
130
127
  *
131
- * @param blockAris - Array of block ARIs to retrieve
128
+ * @param blockIdentifiers - Array of block identifiers to retrieve
132
129
  * @returns A promise containing arrays of successfully fetched blocks and any errors encountered
133
130
  */
134
- export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, documentAri, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
131
+ export declare const batchRetrieveSyncedBlocks: ({ blockIdentifiers, }: BatchRetrieveSyncedBlocksRequest) => Promise<BatchRetrieveSyncedBlocksResponse>;
135
132
  export declare const deleteSyncedBlock: ({ blockAri, deleteReason, }: DeleteSyncedBlockRequest) => Promise<void>;
136
133
  export declare const updateSyncedBlock: ({ blockAri, content, stepVersion, status, }: UpdateSyncedBlockRequest) => Promise<void>;
137
134
  export declare const createSyncedBlock: ({ blockAri, blockInstanceId, sourceAri, product, content, stepVersion, status, }: CreateSyncedBlockRequest) => Promise<BlockContentResponse>;
@@ -64,7 +64,6 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
64
64
  interface BlockServiceADFWriteProviderProps {
65
65
  cloudId: string;
66
66
  getVersion?: () => Promise<number | undefined>;
67
- isParentUnpublished?: () => boolean;
68
67
  parentAri: string | undefined;
69
68
  parentId?: string;
70
69
  product: SyncBlockProduct;
@@ -76,10 +75,9 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
76
75
  private cloudId;
77
76
  private parentId?;
78
77
  private getVersion?;
79
- private isParentUnpublished?;
80
78
  product: SyncBlockProduct;
81
79
  parentAri: string | undefined;
82
- constructor({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: BlockServiceADFWriteProviderProps);
80
+ constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
83
81
  writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
84
82
  createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
85
83
  deleteData(resourceId: string, deleteReason: string | undefined): Promise<DeleteSyncBlockResult>;
@@ -90,12 +88,11 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
90
88
  interface BlockServiceAPIProvidersProps {
91
89
  cloudId: string;
92
90
  getVersion?: () => Promise<number | undefined>;
93
- isParentUnpublished?: () => boolean;
94
91
  parentAri: string | undefined;
95
92
  parentId?: string;
96
93
  product: SyncBlockProduct;
97
94
  }
98
- export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, isParentUnpublished, }: BlockServiceAPIProvidersProps) => {
95
+ export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
99
96
  fetchProvider: BlockServiceADFFetchProvider;
100
97
  writeProvider: BlockServiceADFWriteProvider;
101
98
  };
@@ -6,14 +6,12 @@ import { type ResourceId, type SyncBlockNode, type SyncBlockPrefetchData } from
6
6
  import type { SyncBlockInstance, SubscriptionCallback, SyncBlockDataProvider, TitleSubscriptionCallback, SyncBlockSourceInfo } from '../providers/types';
7
7
  export declare class ReferenceSyncBlockStoreManager {
8
8
  private dataProvider?;
9
- private syncBlockCache;
10
9
  private isCacheDirty;
11
10
  private subscriptions;
12
11
  private titleSubscriptions;
13
12
  private providerFactories;
14
13
  private fireAnalyticsEvent?;
15
14
  private syncBlockFetchDataRequests;
16
- private syncBlockSourceInfoRequestsOld;
17
15
  private syncBlockSourceInfoRequests;
18
16
  private isRefreshingSubscriptions;
19
17
  private pendingCacheDeletions;
@@ -6,15 +6,12 @@ export type ConfirmationCallback = (syncBlockIds: SyncBlockAttrs[], deleteReason
6
6
  type OnDelete = () => void;
7
7
  type OnCompletion = (success: boolean) => void;
8
8
  type DestroyCallback = () => void;
9
- export type CreationCallback = () => void;
10
9
  export declare class SourceSyncBlockStoreManager {
11
10
  private dataProvider?;
12
11
  private fireAnalyticsEvent?;
13
12
  private syncBlockCache;
14
13
  private confirmationCallback?;
15
14
  private deletionRetryInfo?;
16
- private pendingResourceId?;
17
- private creationCallback?;
18
15
  private creationCompletionCallbacks;
19
16
  private createExperience;
20
17
  private saveExperience;
@@ -34,23 +31,12 @@ export declare class SourceSyncBlockStoreManager {
34
31
  * @returns true if saving all nodes successfully, false if fail to save some/all nodes
35
32
  */
36
33
  flush(): Promise<boolean>;
37
- registerPendingCreation(resourceId: ResourceId): void;
38
34
  isPendingCreation(resourceId: ResourceId): boolean;
39
- /**
40
- * Register callback function (which inserts node, handles focus etc) to be used later when creation to backend succeed
41
- */
42
- registerCreationCallback(callback: CreationCallback): void;
43
35
  /**
44
36
  * Fires callback to insert node (if creation is successful) and clears pending creation data
45
37
  * @param success
46
38
  */
47
39
  commitPendingCreation(success: boolean, resourceId: ResourceId): void;
48
- /**
49
- *
50
- * @returns true if waiting for the result of saving new bodiedSyncBlock to backend
51
- * Remove this method when cleaning up platform_synced_block_patch_1
52
- */
53
- hasPendingCreation(): boolean;
54
40
  registerConfirmationCallback(callback: ConfirmationCallback): () => void;
55
41
  requireConfirmationBeforeDelete(): boolean;
56
42
  /**
package/package.json CHANGED
@@ -37,7 +37,7 @@
37
37
  "uuid": "^3.1.0"
38
38
  },
39
39
  "peerDependencies": {
40
- "@atlaskit/editor-common": "^111.12.0",
40
+ "@atlaskit/editor-common": "^111.13.0",
41
41
  "react": "^18.2.0"
42
42
  },
43
43
  "devDependencies": {
@@ -80,7 +80,7 @@
80
80
  }
81
81
  },
82
82
  "name": "@atlaskit/editor-synced-block-provider",
83
- "version": "3.28.0",
83
+ "version": "3.29.0",
84
84
  "description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
85
85
  "author": "Atlassian Pty Ltd",
86
86
  "license": "Apache-2.0",
@@ -88,9 +88,6 @@
88
88
  "registry": "https://registry.npmjs.org/"
89
89
  },
90
90
  "platform-feature-flags": {
91
- "platform_synced_block_patch_1": {
92
- "type": "boolean"
93
- },
94
91
  "platform_synced_block_patch_2": {
95
92
  "type": "boolean"
96
93
  }