@backstage/plugin-catalog-react 0.8.0 → 0.9.0

package/CHANGELOG.md

@@ -1,5 +1,71 @@
 # @backstage/plugin-catalog-react
 
+## 0.9.0
+
+### Minor Changes
+
+- b0af81726d: **BREAKING**: Removed `reduceCatalogFilters` and `reduceEntityFilters` due to low external utility value.
+- 7ffb2c73c9: **BREAKING**: Removed the deprecated `loadCatalogOwnerRefs` function. Usages of this function can be directly replaced with `ownershipEntityRefs` from `identityApi.getBackstageIdentity()`.
+
+  This also affects the `useEntityOwnership` hook in that it no longer uses `loadCatalogOwnerRefs`, meaning it will no longer load in additional relations and instead only rely on the `ownershipEntityRefs` from the `IdentityApi`.
+
+- dd88d1e3ac: **BREAKING**: Removed `useEntityFromUrl`.
+- 9844d4d2bd: **BREAKING**: Removed `useEntityCompoundName`, use `useRouteRefParams(entityRouteRef)` instead.
+- 2b8c986ce0: **BREAKING**: Removed `useEntityListProvider` use `useEntityList` instead.
+- f3a7a9de6d: **BREAKING**: Removed `useOwnedEntities` and moved its usage internally to the scaffolder-backend where it's used.
+
+  **BREAKING**: Removed `EntityTypeReturn` type which is now inlined.
+
+- cf1ff5b438: **BREAKING**: Removed the `useEntityKinds` hook, use `catalogApi.getEntityFacets({ facets: ['kind'] })` instead.
+- fc6290a76d: **BREAKING**: Removed the deprecated `useOwnUser` hook. Existing usage can be replaced with `identityApi.getBackstageIdentity()`, followed by a call to `catalogClient.getEntityByRef(identity.userEntityRef)`.
+
+### Patch Changes
+
+- b1aacbf96a: Applied the fix for the `/alpha` entry point resolution that was part of the `v0.70.1` release of Backstage.
+- 2986f8e09d: Fixed EntityOwnerPicker and OwnershipCard url filter issue with more than 21 owners
+- f3a7a9de6d: Internalized usage of `useOwnedEntities` hook.
+- Updated dependencies
+  - @backstage/core-components@0.9.1
+  - @backstage/catalog-model@0.13.0
+  - @backstage/catalog-client@0.9.0
+
+## 0.9.0-next.0
+
+### Minor Changes
+
+- b0af81726d: **BREAKING**: Removed `reduceCatalogFilters` and `reduceEntityFilters` due to low external utility value.
+- 7ffb2c73c9: **BREAKING**: Removed the deprecated `loadCatalogOwnerRefs` function. Usages of this function can be directly replaced with `ownershipEntityRefs` from `identityApi.getBackstageIdentity()`.
+
+  This also affects the `useEntityOwnership` hook in that it no longer uses `loadCatalogOwnerRefs`, meaning it will no longer load in additional relations and instead only rely on the `ownershipEntityRefs` from the `IdentityApi`.
+
+- dd88d1e3ac: **BREAKING**: Removed `useEntityFromUrl`.
+- 9844d4d2bd: **BREAKING**: Removed `useEntityCompoundName`, use `useRouteRefParams(entityRouteRef)` instead.
+- 2b8c986ce0: **BREAKING**: Removed `useEntityListProvider` use `useEntityList` instead.
+- f3a7a9de6d: **BREAKING**: Removed `useOwnedEntities` and moved its usage internally to the scaffolder-backend where it's used.
+
+  **BREAKING**: Removed `EntityTypeReturn` type which is now inlined.
+
+- cf1ff5b438: **BREAKING**: Removed the `useEntityKinds` hook, use `catalogApi.getEntityFacets({ facets: ['kind'] })` instead.
+- fc6290a76d: **BREAKING**: Removed the deprecated `useOwnUser` hook. Existing usage can be replaced with `identityApi.getBackstageIdentity()`, followed by a call to `catalogClient.getEntityByRef(identity.userEntityRef)`.
+
+### Patch Changes
+
+- b1aacbf96a: Applied the fix for the `/alpha` entry point resolution that was part of the `v0.70.1` release of Backstage.
+- 2986f8e09d: Fixed EntityOwnerPicker and OwnershipCard url filter issue with more than 21 owners
+- f3a7a9de6d: Internalized usage of `useOwnedEntities` hook.
+- Updated dependencies
+  - @backstage/core-components@0.9.1-next.0
+  - @backstage/catalog-model@0.13.0-next.0
+  - @backstage/catalog-client@0.9.0-next.0
+
+## 0.8.1
+
+### Patch Changes
+
+- Fixed runtime resolution of the `/alpha` entry point.
+- Updated dependencies
+  - @backstage/catalog-model@0.12.1
+
 ## 0.8.0
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "0.8.0",
-  "main": "..",
+  "version": "0.9.0",
+  "main": "../dist/index.esm.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -7,14 +7,12 @@
 /// <reference types="react" />
 
 import { ApiRef } from '@backstage/core-plugin-api';
-import { AsyncState } from 'react-use/lib/useAsync';
 import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
 import { CatalogApi } from '@backstage/catalog-client';
 import { ComponentEntity } from '@backstage/catalog-model';
 import { ComponentProps } from 'react';
 import { CompoundEntityRef } from '@backstage/catalog-model';
 import { Entity } from '@backstage/catalog-model';
-import { GetEntitiesResponse } from '@backstage/catalog-client';
 import { IconButton } from '@material-ui/core';
 import { LinkProps } from '@backstage/core-components';
 import { Observable } from '@backstage/types';
@@ -28,7 +26,6 @@ import { ScmIntegrationRegistry } from '@backstage/integration';
 import { StyleRules } from '@material-ui/core/styles/withStyles';
 import { SystemEntity } from '@backstage/catalog-model';
 import { TableColumn } from '@backstage/core-components';
-import { UserEntity } from '@backstage/catalog-model';
 
 /**
  * Provides a loaded entity to be picked up by the `useEntity` hook.
@@ -428,17 +425,6 @@ export declare interface EntityTypePickerProps {
     hidden?: boolean;
 }
 
-/** @public
- * @deprecated type inlined with {@link useEntityTypeFilter}.
- */
-export declare type EntityTypeReturn = {
-    loading: boolean;
-    error?: Error;
-    availableTypes: string[];
-    selectedTypes: string[];
-    setSelectedTypes: (types: string[]) => void;
-};
-
 /**
  * IconButton for showing if a current entity is starred and adding/removing it from the favorite entities
  * @param props - MaterialUI IconButton props extended by required `entity` prop
@@ -516,20 +502,6 @@ export declare function InspectEntityDialog(props: {
  */
 export declare function isOwnerOf(owner: Entity, entity: Entity): boolean;
 
-/**
- * Takes the relevant parts of the User entity corresponding to the Backstage
- * identity, and translates them into a list of entity refs on string form that
- * represent the user's ownership connections.
- *
- * @public
- *
- * @param catalogApi - The Catalog API implementation
- * @param identityOwnerRefs - List of identity owner refs as strings
- * @returns OwnerRefs as a string array
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- */
-export declare function loadCatalogOwnerRefs(catalogApi: CatalogApi, identityOwnerRefs: string[]): Promise<string[]>;
-
 /** @public */
 export declare const MockEntityListContextProvider: ({ children, value, }: React_2.PropsWithChildren<{
     value?: Partial<EntityListContextProps<DefaultEntityFilters>> | undefined;
@@ -548,18 +520,6 @@ export declare class MockStarredEntitiesApi implements StarredEntitiesApi {
     starredEntitie$(): Observable<Set<string>>;
 }
 
-/**
- * @public
- * @deprecated will be made private.
- */
-export declare function reduceCatalogFilters(filters: EntityFilter[]): Record<string, string | symbol | (string | symbol)[]>;
-
-/**
- * @public
- * @deprecated will be made private.
- */
-export declare function reduceEntityFilters(filters: EntityFilter[]): (entity: Entity) => boolean;
-
 /**
  * An API to store and retrieve starred entities
  *
@@ -619,46 +579,12 @@ export declare function useEntity<TEntity extends Entity = Entity>(): {
     refresh?: VoidFunction;
 };
 
-/**
- * Grabs entity kind, namespace, and name from the location
- * @public
- * @deprecated use {@link @backstage/core-plugin-api#useRouteRefParams} instead
- */
-export declare const useEntityCompoundName: () => {
-    kind: string;
-    namespace: string;
-    name: string;
-};
-
-/** @public
- * @deprecated will be deleted shortly due to low external usage, re-implement if needed.
- */
-export declare const useEntityFromUrl: () => EntityLoadingStatus;
-
-/**
- * Retrieve a list of unique entity kinds present in the catalog
- * @public
- * @deprecated and will be removed due to low utility value.
- */
-export declare function useEntityKinds(): {
-    error: Error | undefined;
-    loading: boolean;
-    kinds: string[] | undefined;
-};
-
 /**
  * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
  * @public
  */
 export declare function useEntityList<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
 
-/**
- * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
- * @public
- * @deprecated use {@link useEntityList} instead.
- */
-export declare function useEntityListProvider<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
-
 /**
  * Returns a function that checks whether the currently signed-in user is an
  * owner of a given entity. When the hook is initially mounted, the loading
@@ -704,28 +630,6 @@ export declare function useEntityTypeFilter(): {
     setSelectedTypes: (types: string[]) => void;
 };
 
-/**
- * Takes the relevant parts of the Backstage identity, and translates them into
- * a list of entities which are owned by the user. Takes an optional parameter
- * to filter the entities based on allowedKinds
- *
- * @public
- *
- * @param allowedKinds - Array of allowed kinds to filter the entities
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- */
-export declare function useOwnedEntities(allowedKinds?: string[]): {
-    loading: boolean;
-    ownedEntities: GetEntitiesResponse | undefined;
-};
-
-/**
- * Get the catalog User entity (if any) that matches the logged-in user.
- * @public
- * @deprecated due to low external usage.
- */
-export declare function useOwnUser(): AsyncState<UserEntity | undefined>;
-
 /** @public */
 export declare function useRelatedEntities(entity: Entity, relationFilter: {
     type?: string;

package/dist/index.beta.d.ts

@@ -7,14 +7,12 @@
 /// <reference types="react" />
 
 import { ApiRef } from '@backstage/core-plugin-api';
-import { AsyncState } from 'react-use/lib/useAsync';
 import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
 import { CatalogApi } from '@backstage/catalog-client';
 import { ComponentEntity } from '@backstage/catalog-model';
 import { ComponentProps } from 'react';
 import { CompoundEntityRef } from '@backstage/catalog-model';
 import { Entity } from '@backstage/catalog-model';
-import { GetEntitiesResponse } from '@backstage/catalog-client';
 import { IconButton } from '@material-ui/core';
 import { LinkProps } from '@backstage/core-components';
 import { Observable } from '@backstage/types';
@@ -28,7 +26,6 @@ import { ScmIntegrationRegistry } from '@backstage/integration';
 import { StyleRules } from '@material-ui/core/styles/withStyles';
 import { SystemEntity } from '@backstage/catalog-model';
 import { TableColumn } from '@backstage/core-components';
-import { UserEntity } from '@backstage/catalog-model';
 
 /**
  * Provides a loaded entity to be picked up by the `useEntity` hook.
@@ -428,17 +425,6 @@ export declare interface EntityTypePickerProps {
     hidden?: boolean;
 }
 
-/** @public
- * @deprecated type inlined with {@link useEntityTypeFilter}.
- */
-export declare type EntityTypeReturn = {
-    loading: boolean;
-    error?: Error;
-    availableTypes: string[];
-    selectedTypes: string[];
-    setSelectedTypes: (types: string[]) => void;
-};
-
 /**
  * IconButton for showing if a current entity is starred and adding/removing it from the favorite entities
  * @param props - MaterialUI IconButton props extended by required `entity` prop
@@ -507,20 +493,6 @@ export declare function InspectEntityDialog(props: {
 
 /* Excluded from this release type: isOwnerOf */
 
-/**
- * Takes the relevant parts of the User entity corresponding to the Backstage
- * identity, and translates them into a list of entity refs on string form that
- * represent the user's ownership connections.
- *
- * @public
- *
- * @param catalogApi - The Catalog API implementation
- * @param identityOwnerRefs - List of identity owner refs as strings
- * @returns OwnerRefs as a string array
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- */
-export declare function loadCatalogOwnerRefs(catalogApi: CatalogApi, identityOwnerRefs: string[]): Promise<string[]>;
-
 /** @public */
 export declare const MockEntityListContextProvider: ({ children, value, }: React_2.PropsWithChildren<{
     value?: Partial<EntityListContextProps<DefaultEntityFilters>> | undefined;
@@ -539,18 +511,6 @@ export declare class MockStarredEntitiesApi implements StarredEntitiesApi {
     starredEntitie$(): Observable<Set<string>>;
 }
 
-/**
- * @public
- * @deprecated will be made private.
- */
-export declare function reduceCatalogFilters(filters: EntityFilter[]): Record<string, string | symbol | (string | symbol)[]>;
-
-/**
- * @public
- * @deprecated will be made private.
- */
-export declare function reduceEntityFilters(filters: EntityFilter[]): (entity: Entity) => boolean;
-
 /**
  * An API to store and retrieve starred entities
  *
@@ -610,46 +570,12 @@ export declare function useEntity<TEntity extends Entity = Entity>(): {
     refresh?: VoidFunction;
 };
 
-/**
- * Grabs entity kind, namespace, and name from the location
- * @public
- * @deprecated use {@link @backstage/core-plugin-api#useRouteRefParams} instead
- */
-export declare const useEntityCompoundName: () => {
-    kind: string;
-    namespace: string;
-    name: string;
-};
-
-/** @public
- * @deprecated will be deleted shortly due to low external usage, re-implement if needed.
- */
-export declare const useEntityFromUrl: () => EntityLoadingStatus;
-
-/**
- * Retrieve a list of unique entity kinds present in the catalog
- * @public
- * @deprecated and will be removed due to low utility value.
- */
-export declare function useEntityKinds(): {
-    error: Error | undefined;
-    loading: boolean;
-    kinds: string[] | undefined;
-};
-
 /**
  * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
  * @public
  */
 export declare function useEntityList<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
 
-/**
- * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
- * @public
- * @deprecated use {@link useEntityList} instead.
- */
-export declare function useEntityListProvider<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
-
 /**
  * Returns a function that checks whether the currently signed-in user is an
  * owner of a given entity. When the hook is initially mounted, the loading
@@ -680,28 +606,6 @@ export declare function useEntityTypeFilter(): {
     setSelectedTypes: (types: string[]) => void;
 };
 
-/**
- * Takes the relevant parts of the Backstage identity, and translates them into
- * a list of entities which are owned by the user. Takes an optional parameter
- * to filter the entities based on allowedKinds
- *
- * @public
- *
- * @param allowedKinds - Array of allowed kinds to filter the entities
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- */
-export declare function useOwnedEntities(allowedKinds?: string[]): {
-    loading: boolean;
-    ownedEntities: GetEntitiesResponse | undefined;
-};
-
-/**
- * Get the catalog User entity (if any) that matches the logged-in user.
- * @public
- * @deprecated due to low external usage.
- */
-export declare function useOwnUser(): AsyncState<UserEntity | undefined>;
-
 /** @public */
 export declare function useRelatedEntities(entity: Entity, relationFilter: {
     type?: string;

package/dist/index.d.ts

@@ -7,14 +7,12 @@
 /// <reference types="react" />
 
 import { ApiRef } from '@backstage/core-plugin-api';
-import { AsyncState } from 'react-use/lib/useAsync';
 import { CATALOG_FILTER_EXISTS } from '@backstage/catalog-client';
 import { CatalogApi } from '@backstage/catalog-client';
 import { ComponentEntity } from '@backstage/catalog-model';
 import { ComponentProps } from 'react';
 import { CompoundEntityRef } from '@backstage/catalog-model';
 import { Entity } from '@backstage/catalog-model';
-import { GetEntitiesResponse } from '@backstage/catalog-client';
 import { IconButton } from '@material-ui/core';
 import { LinkProps } from '@backstage/core-components';
 import { Observable } from '@backstage/types';
@@ -28,7 +26,6 @@ import { ScmIntegrationRegistry } from '@backstage/integration';
 import { StyleRules } from '@material-ui/core/styles/withStyles';
 import { SystemEntity } from '@backstage/catalog-model';
 import { TableColumn } from '@backstage/core-components';
-import { UserEntity } from '@backstage/catalog-model';
 
 /**
  * Provides a loaded entity to be picked up by the `useEntity` hook.
@@ -428,17 +425,6 @@ export declare interface EntityTypePickerProps {
     hidden?: boolean;
 }
 
-/** @public
- * @deprecated type inlined with {@link useEntityTypeFilter}.
- */
-export declare type EntityTypeReturn = {
-    loading: boolean;
-    error?: Error;
-    availableTypes: string[];
-    selectedTypes: string[];
-    setSelectedTypes: (types: string[]) => void;
-};
-
 /**
  * IconButton for showing if a current entity is starred and adding/removing it from the favorite entities
  * @param props - MaterialUI IconButton props extended by required `entity` prop
@@ -507,20 +493,6 @@ export declare function InspectEntityDialog(props: {
 
 /* Excluded from this release type: isOwnerOf */
 
-/**
- * Takes the relevant parts of the User entity corresponding to the Backstage
- * identity, and translates them into a list of entity refs on string form that
- * represent the user's ownership connections.
- *
- * @public
- *
- * @param catalogApi - The Catalog API implementation
- * @param identityOwnerRefs - List of identity owner refs as strings
- * @returns OwnerRefs as a string array
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- */
-export declare function loadCatalogOwnerRefs(catalogApi: CatalogApi, identityOwnerRefs: string[]): Promise<string[]>;
-
 /** @public */
 export declare const MockEntityListContextProvider: ({ children, value, }: React_2.PropsWithChildren<{
     value?: Partial<EntityListContextProps<DefaultEntityFilters>> | undefined;
@@ -539,18 +511,6 @@ export declare class MockStarredEntitiesApi implements StarredEntitiesApi {
     starredEntitie$(): Observable<Set<string>>;
 }
 
-/**
- * @public
- * @deprecated will be made private.
- */
-export declare function reduceCatalogFilters(filters: EntityFilter[]): Record<string, string | symbol | (string | symbol)[]>;
-
-/**
- * @public
- * @deprecated will be made private.
- */
-export declare function reduceEntityFilters(filters: EntityFilter[]): (entity: Entity) => boolean;
-
 /**
  * An API to store and retrieve starred entities
  *
@@ -610,46 +570,12 @@ export declare function useEntity<TEntity extends Entity = Entity>(): {
     refresh?: VoidFunction;
 };
 
-/**
- * Grabs entity kind, namespace, and name from the location
- * @public
- * @deprecated use {@link @backstage/core-plugin-api#useRouteRefParams} instead
- */
-export declare const useEntityCompoundName: () => {
-    kind: string;
-    namespace: string;
-    name: string;
-};
-
-/** @public
- * @deprecated will be deleted shortly due to low external usage, re-implement if needed.
- */
-export declare const useEntityFromUrl: () => EntityLoadingStatus;
-
-/**
- * Retrieve a list of unique entity kinds present in the catalog
- * @public
- * @deprecated and will be removed due to low utility value.
- */
-export declare function useEntityKinds(): {
-    error: Error | undefined;
-    loading: boolean;
-    kinds: string[] | undefined;
-};
-
 /**
  * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
  * @public
  */
 export declare function useEntityList<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
 
-/**
- * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
- * @public
- * @deprecated use {@link useEntityList} instead.
- */
-export declare function useEntityListProvider<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
-
 /**
  * Returns a function that checks whether the currently signed-in user is an
  * owner of a given entity. When the hook is initially mounted, the loading
@@ -680,28 +606,6 @@ export declare function useEntityTypeFilter(): {
     setSelectedTypes: (types: string[]) => void;
 };
 
-/**
- * Takes the relevant parts of the Backstage identity, and translates them into
- * a list of entities which are owned by the user. Takes an optional parameter
- * to filter the entities based on allowedKinds
- *
- * @public
- *
- * @param allowedKinds - Array of allowed kinds to filter the entities
- * @deprecated Use `ownershipEntityRefs` from `identityApi.getBackstageIdentity()` instead.
- */
-export declare function useOwnedEntities(allowedKinds?: string[]): {
-    loading: boolean;
-    ownedEntities: GetEntitiesResponse | undefined;
-};
-
-/**
- * Get the catalog User entity (if any) that matches the logged-in user.
- * @public
- * @deprecated due to low external usage.
- */
-export declare function useOwnUser(): AsyncState<UserEntity | undefined>;
-
 /** @public */
 export declare function useRelatedEntities(entity: Entity, relationFilter: {
     type?: string;