@atlaskit/editor-synced-block-provider 3.13.2 → 3.14.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 (7) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/cjs/providers/block-service/blockServiceAPI.js +5 -1
  3. package/dist/es2019/providers/block-service/blockServiceAPI.js +5 -1
  4. package/dist/esm/providers/block-service/blockServiceAPI.js +5 -1
  5. package/dist/types/providers/block-service/blockServiceAPI.d.ts +9 -6
  6. package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts +9 -6
  7. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @atlaskit/editor-synced-block-provider
2
2
 
3
+ ## 3.14.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`55d9a4080dfa8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/55d9a4080dfa8) -
8
+ parentAri field for fetch/write providers are mandatory
9
+
3
10
  ## 3.13.2
4
11
 
5
12
  ### Patch Changes
package/dist/cjs/providers/block-service/blockServiceAPI.js CHANGED
@@ -903,7 +903,7 @@ var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(_re
903
903
  return {
904
904
  fetchProvider: new BlockServiceADFFetchProvider({
905
905
  cloudId: cloudId,
906
- parentAri: (0, _platformFeatureFlags.fg)('platform_synced_block_dogfooding') ? parentAri : undefined
906
+ parentAri: parentAri
907
907
  }),
908
908
  writeProvider: new BlockServiceADFWriteProvider({
909
909
  cloudId: cloudId,
@@ -941,6 +941,10 @@ var createBlockServiceFetchOnlyAPIProvider = function createBlockServiceFetchOnl
941
941
  writeProvider: undefined
942
942
  };
943
943
  };
944
+
945
+ /**
946
+ * If the parentAri is not a valid ARI, pass in an empty string.
947
+ */
944
948
  var useMemoizedBlockServiceFetchOnlyAPIProvider = exports.useMemoizedBlockServiceFetchOnlyAPIProvider = function useMemoizedBlockServiceFetchOnlyAPIProvider(_ref8) {
945
949
  var cloudId = _ref8.cloudId,
946
950
  parentAri = _ref8.parentAri;
package/dist/es2019/providers/block-service/blockServiceAPI.js CHANGED
@@ -621,7 +621,7 @@ const createBlockServiceAPIProviders = ({
621
621
  return {
622
622
  fetchProvider: new BlockServiceADFFetchProvider({
623
623
  cloudId,
624
- parentAri: fg('platform_synced_block_dogfooding') ? parentAri : undefined
624
+ parentAri
625
625
  }),
626
626
  writeProvider: new BlockServiceADFWriteProvider({
627
627
  cloudId,
@@ -661,6 +661,10 @@ const createBlockServiceFetchOnlyAPIProvider = ({
661
661
  writeProvider: undefined
662
662
  };
663
663
  };
664
+
665
+ /**
666
+ * If the parentAri is not a valid ARI, pass in an empty string.
667
+ */
664
668
  export const useMemoizedBlockServiceFetchOnlyAPIProvider = ({
665
669
  cloudId,
666
670
  parentAri
package/dist/esm/providers/block-service/blockServiceAPI.js CHANGED
@@ -897,7 +897,7 @@ var createBlockServiceAPIProviders = function createBlockServiceAPIProviders(_re
897
897
  return {
898
898
  fetchProvider: new BlockServiceADFFetchProvider({
899
899
  cloudId: cloudId,
900
- parentAri: fg('platform_synced_block_dogfooding') ? parentAri : undefined
900
+ parentAri: parentAri
901
901
  }),
902
902
  writeProvider: new BlockServiceADFWriteProvider({
903
903
  cloudId: cloudId,
@@ -935,6 +935,10 @@ var createBlockServiceFetchOnlyAPIProvider = function createBlockServiceFetchOnl
935
935
  writeProvider: undefined
936
936
  };
937
937
  };
938
+
939
+ /**
940
+ * If the parentAri is not a valid ARI, pass in an empty string.
941
+ */
938
942
  export var useMemoizedBlockServiceFetchOnlyAPIProvider = function useMemoizedBlockServiceFetchOnlyAPIProvider(_ref8) {
939
943
  var cloudId = _ref8.cloudId,
940
944
  parentAri = _ref8.parentAri;
package/dist/types/providers/block-service/blockServiceAPI.d.ts CHANGED
@@ -22,14 +22,14 @@ 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
+ parentAri: string | undefined;
26
26
  }
27
27
  /**
28
28
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
29
29
  */
30
30
  declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
31
31
  private cloudId;
32
- private parentAri?;
32
+ private parentAri;
33
33
  constructor({ cloudId, parentAri }: BlockServiceADFFetchProviderProps);
34
34
  fetchData(resourceId: string): Promise<SyncBlockInstance>;
35
35
  fetchReferences(referenceResourceId: string): Promise<ReferenceSyncBlockData>;
@@ -56,7 +56,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
56
56
  interface BlockServiceADFWriteProviderProps {
57
57
  cloudId: string;
58
58
  getVersion?: () => number | undefined;
59
- parentAri?: string;
59
+ parentAri: string | undefined;
60
60
  parentId?: string;
61
61
  product: SyncBlockProduct;
62
62
  }
@@ -68,7 +68,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
68
68
  private parentId?;
69
69
  private getVersion?;
70
70
  product: SyncBlockProduct;
71
- parentAri?: string;
71
+ parentAri: string | undefined;
72
72
  constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
73
73
  writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
74
74
  createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
@@ -80,7 +80,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
80
80
  interface BlockServiceAPIProvidersProps {
81
81
  cloudId: string;
82
82
  getVersion?: () => number | undefined;
83
- parentAri?: string;
83
+ parentAri: string | undefined;
84
84
  parentId?: string;
85
85
  product: SyncBlockProduct;
86
86
  }
@@ -90,8 +90,11 @@ export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri,
90
90
  };
91
91
  interface BlockServiceFetchOnlyAPIProviderProps {
92
92
  cloudId: string;
93
- parentAri?: string;
93
+ parentAri: string | undefined;
94
94
  }
95
+ /**
96
+ * If the parentAri is not a valid ARI, pass in an empty string.
97
+ */
95
98
  export declare const useMemoizedBlockServiceFetchOnlyAPIProvider: ({ cloudId, parentAri, }: BlockServiceFetchOnlyAPIProviderProps) => {
96
99
  fetchProvider: BlockServiceADFFetchProvider;
97
100
  writeProvider: undefined;
package/dist/types-ts4.5/providers/block-service/blockServiceAPI.d.ts CHANGED
@@ -22,14 +22,14 @@ 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
+ parentAri: string | undefined;
26
26
  }
27
27
  /**
28
28
  * ADFFetchProvider implementation that fetches synced block data from Block Service API
29
29
  */
30
30
  declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
31
31
  private cloudId;
32
- private parentAri?;
32
+ private parentAri;
33
33
  constructor({ cloudId, parentAri }: BlockServiceADFFetchProviderProps);
34
34
  fetchData(resourceId: string): Promise<SyncBlockInstance>;
35
35
  fetchReferences(referenceResourceId: string): Promise<ReferenceSyncBlockData>;
@@ -56,7 +56,7 @@ declare class BlockServiceADFFetchProvider implements ADFFetchProvider {
56
56
  interface BlockServiceADFWriteProviderProps {
57
57
  cloudId: string;
58
58
  getVersion?: () => number | undefined;
59
- parentAri?: string;
59
+ parentAri: string | undefined;
60
60
  parentId?: string;
61
61
  product: SyncBlockProduct;
62
62
  }
@@ -68,7 +68,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
68
68
  private parentId?;
69
69
  private getVersion?;
70
70
  product: SyncBlockProduct;
71
- parentAri?: string;
71
+ parentAri: string | undefined;
72
72
  constructor({ cloudId, parentAri, parentId, product, getVersion, }: BlockServiceADFWriteProviderProps);
73
73
  writeData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
74
74
  createData(data: SyncBlockData): Promise<WriteSyncBlockResult>;
@@ -80,7 +80,7 @@ declare class BlockServiceADFWriteProvider implements ADFWriteProvider {
80
80
  interface BlockServiceAPIProvidersProps {
81
81
  cloudId: string;
82
82
  getVersion?: () => number | undefined;
83
- parentAri?: string;
83
+ parentAri: string | undefined;
84
84
  parentId?: string;
85
85
  product: SyncBlockProduct;
86
86
  }
@@ -90,8 +90,11 @@ export declare const useMemoizedBlockServiceAPIProviders: ({ cloudId, parentAri,
90
90
  };
91
91
  interface BlockServiceFetchOnlyAPIProviderProps {
92
92
  cloudId: string;
93
- parentAri?: string;
93
+ parentAri: string | undefined;
94
94
  }
95
+ /**
96
+ * If the parentAri is not a valid ARI, pass in an empty string.
97
+ */
95
98
  export declare const useMemoizedBlockServiceFetchOnlyAPIProvider: ({ cloudId, parentAri, }: BlockServiceFetchOnlyAPIProviderProps) => {
96
99
  fetchProvider: BlockServiceADFFetchProvider;
97
100
  writeProvider: undefined;
package/package.json CHANGED
@@ -78,7 +78,7 @@
78
78
  }
79
79
  },
80
80
  "name": "@atlaskit/editor-synced-block-provider",
81
- "version": "3.13.2",
81
+ "version": "3.14.0",
82
82
  "description": "Synced Block Provider for @atlaskit/editor-plugin-synced-block",
83
83
  "author": "Atlassian Pty Ltd",
84
84
  "license": "Apache-2.0",