catalog-react: deprecate EntityContext and add AsyncEntityProvider

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

.changeset/weak-drinks-promise.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-react': patch
+---
+
+Deprecated EntityContext in favor of using `useEntity`, `EntityProvider` and the new `AsyncEntityProvider` instead. This update also brings cross-version compatibility to `@backstage/catalog-react`, meaning that future versions can be used in parallel with this one.

plugins/catalog-react/api-report.md

@@ -25,6 +25,29 @@ import { SystemEntity } from '@backstage/catalog-model';
 import { TableColumn } from '@backstage/core-components';
 import { UserEntity } from '@backstage/catalog-model';
 
+// @public
+export const AsyncEntityProvider: ({
+  children,
+  entity,
+  loading,
+  error,
+  refresh,
+}: AsyncEntityProviderProps) => JSX.Element;
+
+// @public
+export interface AsyncEntityProviderProps {
+  // (undocumented)
+  children: ReactNode;
+  // (undocumented)
+  entity?: Entity;
+  // (undocumented)
+  error?: Error;
+  // (undocumented)
+  loading: boolean;
+  // (undocumented)
+  refresh?: VoidFunction;
+}
+
 export { CATALOG_FILTER_EXISTS };
 
 export { CatalogApi };
@@ -109,9 +132,8 @@ export type DefaultEntityFilters = {
 };
 
 // Warning: (ae-forgotten-export) The symbol "EntityLoadingStatus" needs to be exported by the entry point index.d.ts
-// Warning: (ae-missing-release-tag) "EntityContext" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export const EntityContext: Context<EntityLoadingStatus>;
 
 // Warning: (ae-missing-release-tag) "EntityFilter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -199,15 +221,20 @@ export class EntityOwnerFilter implements EntityFilter {
 // @public (undocumented)
 export const EntityOwnerPicker: () => JSX.Element | null;
 
-// Warning: (ae-forgotten-export) The symbol "EntityProviderProps" needs to be exported by the entry point index.d.ts
-// Warning: (ae-missing-release-tag) "EntityProvider" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export const EntityProvider: ({
   entity,
   children,
 }: EntityProviderProps) => JSX.Element;
 
+// @public
+export interface EntityProviderProps {
+  // (undocumented)
+  children: ReactNode;
+  // (undocumented)
+  entity?: Entity;
+}
+
 // Warning: (ae-forgotten-export) The symbol "EntityRefLinkProps" needs to be exported by the entry point index.d.ts
 // Warning: (ae-missing-release-tag) "EntityRefLink" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -726,8 +753,6 @@ export const UnregisterEntityDialog: ({
   entity,
 }: Props_3) => JSX.Element;
 
-// Warning: (ae-missing-release-tag) "useEntity" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
 // @public
 export function useEntity<T extends Entity = Entity>(): {
   entity: T;

plugins/catalog-react/package.json

@@ -34,6 +34,7 @@
     "@backstage/core-components": "^0.4.0",
     "@backstage/core-plugin-api": "^0.1.6",
     "@backstage/integration": "^0.6.3",
+    "@backstage/version-bridge": "^0.1.0",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.45",

plugins/catalog-react/src/components/index.ts

@@ -16,7 +16,6 @@
 export * from './EntityKindPicker';
 export * from './EntityLifecyclePicker';
 export * from './EntityOwnerPicker';
-export * from './EntityProvider';
 export * from './EntityRefLink';
 export * from './EntitySearchBar';
 export * from './EntityTable';

plugins/catalog-react/src/hooks/index.ts

@@ -13,7 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { EntityContext, useEntity, useEntityFromUrl } from './useEntity';
+export {
+  EntityContext,
+  useEntity,
+  useEntityFromUrl,
+  EntityProvider,
+  AsyncEntityProvider,
+} from './useEntity';
+export type {
+  EntityProviderProps,
+  AsyncEntityProviderProps,
+} from './useEntity';
 export { useEntityCompoundName } from './useEntityCompoundName';
 export {
   EntityListContext,