@atlaskit/editor-synced-block-provider 3.5.2 → 3.5.3

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 +8 -0
  2. package/dist/cjs/clients/block-service/blockService.js +14 -9
  3. package/dist/cjs/index.js +0 -24
  4. package/dist/cjs/providers/block-service/blockServiceAPI.js +89 -49
  5. package/dist/cjs/providers/syncBlockProvider.js +20 -30
  6. package/dist/cjs/store-manager/referenceSyncBlockStoreManager.js +9 -3
  7. package/dist/cjs/store-manager/syncBlockStoreManager.js +1 -8
  8. package/dist/es2019/clients/block-service/blockService.js +6 -1
  9. package/dist/es2019/index.js +3 -3
  10. package/dist/es2019/providers/block-service/blockServiceAPI.js +34 -6
  11. package/dist/es2019/providers/syncBlockProvider.js +3 -17
  12. package/dist/es2019/store-manager/referenceSyncBlockStoreManager.js +3 -0
  13. package/dist/es2019/store-manager/syncBlockStoreManager.js +0 -8
  14. package/dist/esm/clients/block-service/blockService.js +14 -9
  15. package/dist/esm/index.js +3 -3
  16. package/dist/esm/providers/block-service/blockServiceAPI.js +88 -48
  17. package/dist/esm/providers/syncBlockProvider.js +19 -29
  18. package/dist/esm/store-manager/referenceSyncBlockStoreManager.js +9 -3
  19. package/dist/esm/store-manager/syncBlockStoreManager.js +0 -7
  20. package/dist/types/index.d.ts +3 -3
  21. package/dist/types/providers/block-service/blockServiceAPI.d.ts +9 -15
  22. package/dist/types/providers/syncBlockProvider.d.ts +0 -1
  23. package/dist/types/store-manager/syncBlockStoreManager.d.ts +0 -4
  24. package/dist/types-ts4.5/index.d.ts +3 -3
  25. package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts +9 -15
  26. package/dist/types-ts4.5/providers/syncBlockProvider.d.ts +0 -1
  27. package/dist/types-ts4.5/store-manager/syncBlockStoreManager.d.ts +0 -4
  28. package/package.json +2 -2
@@ -7,12 +7,12 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
7
7
  export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
8
8
  export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, } from './clients/confluence/ari';
9
9
  export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';
10
- export { createBlockServiceAPIProviders, createBlockServiceFetchOnlyAPIProvider, useMemoizedBlockServiceAPIProviders, useMemoizedBlockServiceFetchOnlyAPIProvider, } from './providers/block-service/blockServiceAPI';
10
+ export { useMemoizedBlockServiceAPIProviders, useMemoizedBlockServiceFetchOnlyAPIProvider, } from './providers/block-service/blockServiceAPI';
11
11
  export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
12
- export { SyncBlockProvider as SyncedBlockProvider, createAndInitializeSyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
12
+ export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
13
13
  export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, UpdateReferenceSyncBlockResult, WriteSyncBlockResult, SyncBlockParentInfo, } from './providers/types';
14
14
  export { type ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
15
- export { SyncBlockStoreManager, createAndInitializeSyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from './store-manager/syncBlockStoreManager';
15
+ export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from './store-manager/syncBlockStoreManager';
16
16
  export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
17
17
  export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes, getContentIdAndProductFromResourceId, } from './utils/utils';
18
18
  export { fetchErrorPayload } from './utils/errorHandling';
@@ -22,13 +22,15 @@ export declare const convertToSyncBlockData: (data: BlockContentResponse, resour
22
22
  export declare const fetchReferences: (documentAri: string) => Promise<SyncBlockInstance[] | SyncBlockError>;
23
23
  interface BlockServiceADFFetchProviderProps {
24
24
  cloudId: string;
25
+ parentAri?: string;
25
26
  }
26
27
  /**
27
28
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
28
29
  */
29
30
  declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
30
31
  private cloudId;
31
- constructor({ cloudId }: BlockServiceADFFetchProviderProps);
32
+ private parentAri?;
33
+ constructor({ cloudId, parentAri }: BlockServiceADFFetchProviderProps);
32
34
  fetchData(resourceId: string): Promise<SyncBlockInstance>;
33
35
  /**
34
36
  * Extracts the resourceId from a block ARI.
@@ -45,8 +47,8 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
45
47
  interface BlockServiceADFWriteProviderProps {
46
48
  cloudId: string;
47
49
  getVersion?: () => number | undefined;
48
- parentAri: string;
49
- parentId: string;
50
+ parentAri?: string;
51
+ parentId?: string;
50
52
  product: SyncBlockProduct;
51
53
  }
52
54
  /**
@@ -54,8 +56,8 @@ interface BlockServiceADFWriteProviderProps {
54
56
  */
55
57
  declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
56
58
  private cloudId;
57
- private parentAri;
58
- private parentId;
59
+ private parentAri?;
60
+ private parentId?;
59
61
  private getVersion?;
60
62
  product: SyncBlockProduct;
61
63
  constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
@@ -69,14 +71,10 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
69
71
  interface BlockServiceAPIProvidersProps {
70
72
  cloudId: string;
71
73
  getVersion?: () => number | undefined;
72
- parentAri: string;
73
- parentId: string;
74
+ parentAri?: string;
75
+ parentId?: string;
74
76
  product: SyncBlockProduct;
75
77
  }
76
- export declare const createBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
77
- fetchProvider: BlockServiceADFFetchProvider;
78
- writeProvider: BlockServiceADFWriteProvider;
79
- };
80
78
  export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
81
79
  fetchProvider: BlockServiceADFFetchProvider;
82
80
  writeProvider: BlockServiceADFWriteProvider;
@@ -85,10 +83,6 @@ interface BlockServiceFetchOnlyAPIProviderProps {
85
83
  cloudId: string;
86
84
  parentAri?: string;
87
85
  }
88
- export declare const createBlockServiceFetchOnlyAPIProvider: ({ cloudId, }: BlockServiceFetchOnlyAPIProviderProps) => {
89
- fetchProvider: BlockServiceADFFetchProvider;
90
- writeProvider: undefined;
91
- };
92
86
  export declare const useMemoizedBlockServiceFetchOnlyAPIProvider: ({ cloudId, parentAri, }: BlockServiceFetchOnlyAPIProviderProps) => {
93
87
  fetchProvider: BlockServiceADFFetchProvider;
94
88
  writeProvider: undefined;
@@ -97,6 +97,5 @@ type UseMemoizedSyncedBlockProviderProps = {
97
97
  providerOptions: SyncedBlockRendererProviderOptions;
98
98
  writeProvider: ADFWriteProvider | undefined;
99
99
  };
100
- export declare const createAndInitializeSyncedBlockProvider: ({ fetchProvider, writeProvider, providerOptions, getSSRData, }: UseMemoizedSyncedBlockProviderProps) => SyncBlockProvider;
101
100
  export declare const useMemoizedSyncedBlockProvider: ({ fetchProvider, writeProvider, providerOptions, getSSRData, }: UseMemoizedSyncedBlockProviderProps) => SyncBlockProvider;
102
101
  export {};
@@ -11,8 +11,4 @@ export declare class SyncBlockStoreManager {
11
11
  get sourceManager(): SourceSyncBlockStoreManager;
12
12
  destroy(): void;
13
13
  }
14
- export declare const createAndInitializeSyncBlockStoreManager: ({ dataProvider, fireAnalyticsEvent, }: {
15
- dataProvider?: SyncBlockDataProvider;
16
- fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void;
17
- }) => SyncBlockStoreManager;
18
14
  export declare const useMemoizedSyncBlockStoreManager: (dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => SyncBlockStoreManager;
@@ -7,12 +7,12 @@ export { useHandleContentChanges } from './hooks/useHandleContentChanges';
7
7
  export { generateBlockAri, generateBlockAriFromReference, getLocalIdFromBlockResourceId, } from './clients/block-service/ari';
8
8
  export { getConfluencePageAri, getPageIdAndTypeFromConfluencePageAri, } from './clients/confluence/ari';
9
9
  export { getJiraWorkItemAri, getJiraWorkItemIdFromAri } from './clients/jira/ari';
10
- export { createBlockServiceAPIProviders, createBlockServiceFetchOnlyAPIProvider, useMemoizedBlockServiceAPIProviders, useMemoizedBlockServiceFetchOnlyAPIProvider, } from './providers/block-service/blockServiceAPI';
10
+ export { useMemoizedBlockServiceAPIProviders, useMemoizedBlockServiceFetchOnlyAPIProvider, } from './providers/block-service/blockServiceAPI';
11
11
  export { fetchConfluencePageInfo } from './clients/confluence/sourceInfo';
12
- export { SyncBlockProvider as SyncedBlockProvider, createAndInitializeSyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
12
+ export { SyncBlockProvider as SyncedBlockProvider, useMemoizedSyncedBlockProvider, } from './providers/syncBlockProvider';
13
13
  export type { ADFFetchProvider, ADFWriteProvider, SyncBlockDataProvider, SyncBlockInstance, MediaEmojiProviderOptions, SyncedBlockRendererProviderOptions, SyncBlockRendererProviderCreator, SyncedBlockRendererDataProviders, UpdateReferenceSyncBlockResult, WriteSyncBlockResult, SyncBlockParentInfo, } from './providers/types';
14
14
  export { type ReferenceSyncBlockStoreManager } from './store-manager/referenceSyncBlockStoreManager';
15
- export { SyncBlockStoreManager, createAndInitializeSyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from './store-manager/syncBlockStoreManager';
15
+ export { SyncBlockStoreManager, useMemoizedSyncBlockStoreManager, } from './store-manager/syncBlockStoreManager';
16
16
  export { resolveSyncBlockInstance } from './utils/resolveSyncBlockInstance';
17
17
  export { createSyncBlockNode, convertSyncBlockPMNodeToSyncBlockData, convertSyncBlockJSONNodeToSyncBlockNode, convertPMNodesToSyncBlockNodes, getContentIdAndProductFromResourceId, } from './utils/utils';
18
18
  export { fetchErrorPayload } from './utils/errorHandling';
@@ -22,13 +22,15 @@ export declare const convertToSyncBlockData: (data: BlockContentResponse, resour
22
22
  export declare const fetchReferences: (documentAri: string) => Promise<SyncBlockInstance[] | SyncBlockError>;
23
23
  interface BlockServiceADFFetchProviderProps {
24
24
  cloudId: string;
25
+ parentAri?: string;
25
26
  }
26
27
  /**
27
28
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
28
29
  */
29
30
  declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
30
31
  private cloudId;
31
- constructor({ cloudId }: BlockServiceADFFetchProviderProps);
32
+ private parentAri?;
33
+ constructor({ cloudId, parentAri }: BlockServiceADFFetchProviderProps);
32
34
  fetchData(resourceId: string): Promise<SyncBlockInstance>;
33
35
  /**
34
36
  * Extracts the resourceId from a block ARI.
@@ -45,8 +47,8 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
45
47
  interface BlockServiceADFWriteProviderProps {
46
48
  cloudId: string;
47
49
  getVersion?: () => number | undefined;
48
- parentAri: string;
49
- parentId: string;
50
+ parentAri?: string;
51
+ parentId?: string;
50
52
  product: SyncBlockProduct;
51
53
  }
52
54
  /**
@@ -54,8 +56,8 @@ interface BlockServiceADFWriteProviderProps {
54
56
  */
55
57
  declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
56
58
  private cloudId;
57
- private parentAri;
58
- private parentId;
59
+ private parentAri?;
60
+ private parentId?;
59
61
  private getVersion?;
60
62
  product: SyncBlockProduct;
61
63
  constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
@@ -69,14 +71,10 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
69
71
  interface BlockServiceAPIProvidersProps {
70
72
  cloudId: string;
71
73
  getVersion?: () => number | undefined;
72
- parentAri: string;
73
- parentId: string;
74
+ parentAri?: string;
75
+ parentId?: string;
74
76
  product: SyncBlockProduct;
75
77
  }
76
- export declare const createBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
77
- fetchProvider: BlockServiceADFFetchProvider;
78
- writeProvider: BlockServiceADFWriteProvider;
79
- };
80
78
  export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceAPIProvidersProps) => {
81
79
  fetchProvider: BlockServiceADFFetchProvider;
82
80
  writeProvider: BlockServiceADFWriteProvider;
@@ -85,10 +83,6 @@ interface BlockServiceFetchOnlyAPIProviderProps {
85
83
  cloudId: string;
86
84
  parentAri?: string;
87
85
  }
88
- export declare const createBlockServiceFetchOnlyAPIProvider: ({ cloudId, }: BlockServiceFetchOnlyAPIProviderProps) => {
89
- fetchProvider: BlockServiceADFFetchProvider;
90
- writeProvider: undefined;
91
- };
92
86
  export declare const useMemoizedBlockServiceFetchOnlyAPIProvider: ({ cloudId, parentAri, }: BlockServiceFetchOnlyAPIProviderProps) => {
93
87
  fetchProvider: BlockServiceADFFetchProvider;
94
88
  writeProvider: undefined;
@@ -97,6 +97,5 @@ type UseMemoizedSyncedBlockProviderProps = {
97
97
  providerOptions: SyncedBlockRendererProviderOptions;
98
98
  writeProvider: ADFWriteProvider | undefined;
99
99
  };
100
- export declare const createAndInitializeSyncedBlockProvider: ({ fetchProvider, writeProvider, providerOptions, getSSRData, }: UseMemoizedSyncedBlockProviderProps) => SyncBlockProvider;
101
100
  export declare const useMemoizedSyncedBlockProvider: ({ fetchProvider, writeProvider, providerOptions, getSSRData, }: UseMemoizedSyncedBlockProviderProps) => SyncBlockProvider;
102
101
  export {};
@@ -11,8 +11,4 @@ export declare class SyncBlockStoreManager {
11
11
  get sourceManager(): SourceSyncBlockStoreManager;
12
12
  destroy(): void;
13
13
  }
14
- export declare const createAndInitializeSyncBlockStoreManager: ({ dataProvider, fireAnalyticsEvent, }: {
15
- dataProvider?: SyncBlockDataProvider;
16
- fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void;
17
- }) => SyncBlockStoreManager;
18
14
  export declare const useMemoizedSyncBlockStoreManager: (dataProvider?: SyncBlockDataProvider, fireAnalyticsEvent?: (payload: SyncBlockEventPayload) => void) => SyncBlockStoreManager;
package/package.json CHANGED
@@ -34,7 +34,7 @@
34
34
  "uuid": "^3.1.0"
35
35
  },
36
36
  "peerDependencies": {
37
- "@atlaskit/editor-common": "^111.6.0",
37
+ "@atlaskit/editor-common": "^111.7.0",
38
38
  "react": "^18.2.0"
39
39
  },
40
40
  "devDependencies": {
@@ -77,7 +77,7 @@
77
77
  }
78
78
  },
79
79
  "name": "@atlaskit/editor-synced-block-provider",
80
- "version": "3.5.2",
80
+ "version": "3.5.3",
81
81
  "description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
82
82
  "author": "Atlassian Pty Ltd",
83
83
  "license": "Apache-2.0",