@backstage/plugin-catalog-react 1.8.3 → 1.8.4-next.2

package/CHANGELOG.md

@@ -1,40 +1,60 @@
 # @backstage/plugin-catalog-react
 
-## 1.8.3
+## 1.8.4-next.2
 
 ### Patch Changes
 
 - Updated dependencies
-  - @backstage/integration@1.6.2
-  - @backstage/catalog-client@1.4.3
-  - @backstage/catalog-model@1.4.1
-  - @backstage/core-components@0.13.4
-  - @backstage/core-plugin-api@1.5.3
+  - @backstage/core-components@0.13.5-next.2
+  - @backstage/core-plugin-api@1.6.0-next.2
+  - @backstage/plugin-permission-react@0.4.15-next.2
+  - @backstage/integration@1.7.0-next.2
+  - @backstage/catalog-model@1.4.2-next.1
+  - @backstage/plugin-permission-common@0.7.8-next.1
+  - @backstage/catalog-client@1.4.4-next.1
   - @backstage/errors@1.2.1
   - @backstage/theme@0.4.1
   - @backstage/types@1.1.0
   - @backstage/version-bridge@1.0.4
-  - @backstage/plugin-catalog-common@1.0.15
-  - @backstage/plugin-permission-common@0.7.7
-  - @backstage/plugin-permission-react@0.4.14
+  - @backstage/plugin-catalog-common@1.0.16-next.1
 
-## 1.8.2
+## 1.8.4-next.1
 
 ### Patch Changes
 
+- bd817209ddd7: Export the `EntityAutocompletePicker` component.
+- 7029ba1ce0af: Added delete alert popup when user delete the entity
 - Updated dependencies
-  - @backstage/integration@1.6.1
+  - @backstage/core-components@0.13.5-next.1
+  - @backstage/integration@1.7.0-next.1
+  - @backstage/catalog-model@1.4.2-next.0
+  - @backstage/core-plugin-api@1.6.0-next.1
+  - @backstage/plugin-permission-common@0.7.8-next.0
+  - @backstage/plugin-permission-react@0.4.15-next.1
+  - @backstage/catalog-client@1.4.4-next.0
+  - @backstage/plugin-catalog-common@1.0.16-next.0
+  - @backstage/errors@1.2.1
+  - @backstage/theme@0.4.1
+  - @backstage/types@1.1.0
+  - @backstage/version-bridge@1.0.4
+
+## 1.8.3-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@1.7.0-next.0
+  - @backstage/core-plugin-api@1.6.0-next.0
+  - @backstage/core-components@0.13.5-next.0
   - @backstage/catalog-client@1.4.3
   - @backstage/catalog-model@1.4.1
-  - @backstage/core-components@0.13.4
-  - @backstage/core-plugin-api@1.5.3
   - @backstage/errors@1.2.1
   - @backstage/theme@0.4.1
   - @backstage/types@1.1.0
   - @backstage/version-bridge@1.0.4
   - @backstage/plugin-catalog-common@1.0.15
   - @backstage/plugin-permission-common@0.7.7
-  - @backstage/plugin-permission-react@0.4.14
+  - @backstage/plugin-permission-react@0.4.15-next.0
 
 ## 1.8.1
 

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "1.8.3",
+  "version": "1.8.4-next.2",
   "main": "../dist/alpha.esm.js",
   "module": "../dist/alpha.esm.js",
   "types": "../dist/alpha.d.ts"

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { CatalogApi } from '@backstage/catalog-client';
 export { CATALOG_FILTER_EXISTS, CatalogApi } from '@backstage/catalog-client';
 import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
@@ -8,7 +7,7 @@ import React, { PropsWithChildren, ReactNode, ComponentProps } from 'react';
 import * as _backstage_catalog_model from '@backstage/catalog-model';
 import { Entity, CompoundEntityRef } from '@backstage/catalog-model';
 import { LinkProps, InfoCardVariants, TableColumn, TableOptions } from '@backstage/core-components';
-import { IconButton } from '@material-ui/core';
+import { IconButton, TextFieldProps } from '@material-ui/core';
 import { Overrides } from '@material-ui/core/styles/overrides';
 import { StyleRules } from '@material-ui/core/styles/withStyles';
 import { ScmIntegrationRegistry } from '@backstage/integration';
@@ -60,17 +59,17 @@ declare class MockStarredEntitiesApi implements StarredEntitiesApi {
 declare const CatalogFilterLayout: {
     (props: {
         children: React.ReactNode;
-    }): JSX.Element;
+    }): React.JSX.Element;
     Filters: (props: {
         children: React.ReactNode;
         options?: {
             drawerBreakpoint?: 'xs' | 'sm' | 'md' | 'lg' | 'xl' | number;
             drawerAnchor?: 'left' | 'right' | 'top' | 'bottom';
         };
-    }) => JSX.Element;
+    }) => React.JSX.Element;
     Content: (props: {
         children: React.ReactNode;
-    }) => JSX.Element;
+    }) => React.JSX.Element;
 };
 
 /**
@@ -88,14 +87,14 @@ interface EntityKindPickerProps {
     hidden?: boolean;
 }
 /** @public */
-declare const EntityKindPicker: (props: EntityKindPickerProps) => JSX.Element | null;
+declare const EntityKindPicker: (props: EntityKindPickerProps) => React.JSX.Element | null;
 
 /** @public */
 type CatalogReactEntityLifecyclePickerClassKey = 'input';
 /** @public */
 declare const EntityLifecyclePicker: (props: {
     initialFilter?: string[];
-}) => JSX.Element;
+}) => React.JSX.Element;
 
 /** @public */
 type CatalogReactEntityOwnerPickerClassKey = 'input';
@@ -106,7 +105,7 @@ type EntityOwnerPickerProps = {
     mode?: 'owners-only' | 'all';
 };
 /** @public */
-declare const EntityOwnerPicker: (props?: EntityOwnerPickerProps) => JSX.Element | null;
+declare const EntityOwnerPicker: (props?: EntityOwnerPickerProps) => React.JSX.Element | null;
 
 /**
  * Props for {@link EntityRefLink}.
@@ -147,7 +146,7 @@ type EntityRefLinksProps<TRef extends string | CompoundEntityRef | Entity> = ({
  *
  * @public
  */
-declare function EntityRefLinks<TRef extends string | CompoundEntityRef | Entity>(props: EntityRefLinksProps<TRef>): JSX.Element;
+declare function EntityRefLinks<TRef extends string | CompoundEntityRef | Entity>(props: EntityRefLinksProps<TRef>): React.JSX.Element;
 
 /**
  * @param defaultNamespace - if set to false then namespace is never omitted,
@@ -174,7 +173,7 @@ type EntityPeekAheadPopoverProps = PropsWithChildren<{
  *
  * @public
  */
-declare const EntityPeekAheadPopover: (props: EntityPeekAheadPopoverProps) => JSX.Element;
+declare const EntityPeekAheadPopover: (props: EntityPeekAheadPopoverProps) => React.JSX.Element;
 
 /** @public */
 type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
@@ -182,7 +181,7 @@ type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
  * Renders search bar for filtering the entity list.
  * @public
  */
-declare const EntitySearchBar: () => JSX.Element;
+declare const EntitySearchBar: () => React.JSX.Element;
 
 /**
  * Props for {@link EntityTable}.
@@ -204,7 +203,7 @@ interface EntityTableProps<T extends Entity> {
  * @public
  */
 declare const EntityTable: {
-    <T extends Entity>(props: EntityTableProps<T>): JSX.Element;
+    <T extends Entity>(props: EntityTableProps<T>): React.JSX.Element;
     columns: Readonly<{
         createEntityRefColumn<T_1 extends Entity>(options: {
             defaultKind?: string | undefined;
@@ -256,7 +255,7 @@ type EntityTagPickerProps = {
     showCounts?: boolean;
 };
 /** @public */
-declare const EntityTagPicker: (props: EntityTagPickerProps) => JSX.Element;
+declare const EntityTagPicker: (props: EntityTagPickerProps) => React.JSX.Element;
 
 /**
  * Props for {@link EntityTypePicker}.
@@ -268,7 +267,7 @@ interface EntityTypePickerProps {
     hidden?: boolean;
 }
 /** @public */
-declare const EntityTypePicker: (props: EntityTypePickerProps) => JSX.Element | null;
+declare const EntityTypePicker: (props: EntityTypePickerProps) => React.JSX.Element | null;
 
 /** @public */
 type FavoriteEntityProps = ComponentProps<typeof IconButton> & {
@@ -279,7 +278,7 @@ type FavoriteEntityProps = ComponentProps<typeof IconButton> & {
  * @param props - MaterialUI IconButton props extended by required `entity` prop
  * @public
  */
-declare const FavoriteEntity: (props: FavoriteEntityProps) => JSX.Element;
+declare const FavoriteEntity: (props: FavoriteEntityProps) => React.JSX.Element;
 
 /**
  * A dialog that lets users inspect the low level details of their entities.
@@ -290,7 +289,7 @@ declare function InspectEntityDialog(props: {
     open: boolean;
     entity: Entity;
     onClose: () => void;
-}): JSX.Element | null;
+}): React.JSX.Element | null;
 
 /** @public */
 type UnregisterEntityDialogProps = {
@@ -300,7 +299,7 @@ type UnregisterEntityDialogProps = {
     entity: Entity;
 };
 /** @public */
-declare const UnregisterEntityDialog: (props: UnregisterEntityDialogProps) => JSX.Element;
+declare const UnregisterEntityDialog: (props: UnregisterEntityDialogProps) => React.JSX.Element;
 
 /** @public */
 type EntityFilter = {
@@ -335,73 +334,17 @@ type UserListPickerProps = {
     availableFilters?: UserListFilterKind[];
 };
 /** @public */
-declare const UserListPicker: (props: UserListPickerProps) => JSX.Element;
+declare const UserListPicker: (props: UserListPickerProps) => React.JSX.Element;
 
 /** @public */
 type CatalogReactEntityProcessingStatusPickerClassKey = 'input';
 /** @public */
-declare const EntityProcessingStatusPicker: () => JSX.Element;
+declare const EntityProcessingStatusPicker: () => React.JSX.Element;
 
 /** @public */
 type CatalogReactEntityNamespacePickerClassKey = 'input';
 /** @public */
-declare const EntityNamespacePicker: () => JSX.Element;
-
-/** @public */
-type EntityLoadingStatus<TEntity extends Entity = Entity> = {
-    entity?: TEntity;
-    loading: boolean;
-    error?: Error;
-    refresh?: VoidFunction;
-};
-/**
- * Properties for the AsyncEntityProvider component.
- *
- * @public
- */
-interface AsyncEntityProviderProps {
-    children: ReactNode;
-    entity?: Entity;
-    loading: boolean;
-    error?: Error;
-    refresh?: VoidFunction;
-}
-/**
- * Provides a loaded entity to be picked up by the `useEntity` hook.
- *
- * @public
- */
-declare const AsyncEntityProvider: (props: AsyncEntityProviderProps) => JSX.Element;
-/**
- * Properties for the EntityProvider component.
- *
- * @public
- */
-interface EntityProviderProps {
-    children: ReactNode;
-    entity?: Entity;
-}
-/**
- * Provides an entity to be picked up by the `useEntity` hook.
- *
- * @public
- */
-declare const EntityProvider: (props: EntityProviderProps) => JSX.Element;
-/**
- * Grab the current entity from the context, throws if the entity has not yet been loaded
- * or is not available.
- *
- * @public
- */
-declare function useEntity<TEntity extends Entity = Entity>(): {
-    entity: TEntity;
-};
-/**
- * Grab the current entity from the context, provides loading state and errors, and the ability to refresh.
- *
- * @public
- */
-declare function useAsyncEntity<TEntity extends Entity = Entity>(): EntityLoadingStatus<TEntity>;
+declare const EntityNamespacePicker: () => React.JSX.Element;
 
 /**
  * Filter entities based on Kind.
@@ -560,13 +503,90 @@ declare const EntityListContext: React.Context<EntityListContextProps<any> | und
  * Provides entities and filters for a catalog listing.
  * @public
  */
-declare const EntityListProvider: <EntityFilters extends DefaultEntityFilters>(props: PropsWithChildren<{}>) => JSX.Element;
+declare const EntityListProvider: <EntityFilters extends DefaultEntityFilters>(props: PropsWithChildren<{}>) => React.JSX.Element;
 /**
  * Hook for interacting with the entity list context provided by the {@link EntityListProvider}.
  * @public
  */
 declare function useEntityList<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters>(): EntityListContextProps<EntityFilters>;
 
+/** @public */
+type AllowedEntityFilters<T extends DefaultEntityFilters> = {
+    [K in keyof T]-?: NonNullable<T[K]> extends EntityFilter & {
+        values: string[];
+    } ? K : never;
+}[keyof T];
+/** @public */
+type EntityAutocompletePickerProps<T extends DefaultEntityFilters = DefaultEntityFilters, Name extends AllowedEntityFilters<T> = AllowedEntityFilters<T>> = {
+    label: string;
+    name: Name;
+    path: string;
+    showCounts?: boolean;
+    Filter: {
+        new (values: string[]): NonNullable<T[Name]>;
+    };
+    InputProps?: TextFieldProps;
+    initialSelectedOptions?: string[];
+};
+/** @public */
+declare function EntityAutocompletePicker<T extends DefaultEntityFilters = DefaultEntityFilters, Name extends AllowedEntityFilters<T> = AllowedEntityFilters<T>>(props: EntityAutocompletePickerProps<T, Name>): React.JSX.Element | null;
+
+/** @public */
+type EntityLoadingStatus<TEntity extends Entity = Entity> = {
+    entity?: TEntity;
+    loading: boolean;
+    error?: Error;
+    refresh?: VoidFunction;
+};
+/**
+ * Properties for the AsyncEntityProvider component.
+ *
+ * @public
+ */
+interface AsyncEntityProviderProps {
+    children: ReactNode;
+    entity?: Entity;
+    loading: boolean;
+    error?: Error;
+    refresh?: VoidFunction;
+}
+/**
+ * Provides a loaded entity to be picked up by the `useEntity` hook.
+ *
+ * @public
+ */
+declare const AsyncEntityProvider: (props: AsyncEntityProviderProps) => React.JSX.Element;
+/**
+ * Properties for the EntityProvider component.
+ *
+ * @public
+ */
+interface EntityProviderProps {
+    children: ReactNode;
+    entity?: Entity;
+}
+/**
+ * Provides an entity to be picked up by the `useEntity` hook.
+ *
+ * @public
+ */
+declare const EntityProvider: (props: EntityProviderProps) => React.JSX.Element;
+/**
+ * Grab the current entity from the context, throws if the entity has not yet been loaded
+ * or is not available.
+ *
+ * @public
+ */
+declare function useEntity<TEntity extends Entity = Entity>(): {
+    entity: TEntity;
+};
+/**
+ * Grab the current entity from the context, provides loading state and errors, and the ability to refresh.
+ *
+ * @public
+ */
+declare function useAsyncEntity<TEntity extends Entity = Entity>(): EntityLoadingStatus<TEntity>;
+
 /**
  * A hook built on top of `useEntityList` for enabling selection of valid `spec.type` values
  * based on the selected EntityKindFilter.
@@ -651,7 +671,7 @@ declare function entityRouteParams(entity: Entity): {
 /** @public */
 declare function MockEntityListContextProvider<T extends DefaultEntityFilters = DefaultEntityFilters>(props: PropsWithChildren<{
     value?: Partial<EntityListContextProps<T>>;
-}>): JSX.Element;
+}>): React.JSX.Element;
 
 /** @public */
 type CatalogReactComponentsNameToClassKey = {
@@ -684,4 +704,4 @@ type EntitySourceLocation = {
 /** @public */
 declare function getEntitySourceLocation(entity: Entity, scmIntegrationsApi: ScmIntegrationRegistry): EntitySourceLocation | undefined;
 
-export { AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogFilterLayout, CatalogReactComponentsNameToClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityNamespacePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntityProcessingStatusPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, EntityErrorFilter, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityLoadingStatus, EntityNamespaceFilter, EntityNamespacePicker, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityOwnerPickerProps, EntityPeekAheadPopover, EntityPeekAheadPopoverProps, EntityProcessingStatusPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTagPickerProps, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MockEntityListContextProvider, MockStarredEntitiesApi, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, columnFactories, entityRouteParams, entityRouteRef, getEntityRelations, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useAsyncEntity, useEntity, useEntityList, useEntityOwnership, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };
+export { AllowedEntityFilters, AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogFilterLayout, CatalogReactComponentsNameToClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityNamespacePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntityProcessingStatusPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, EntityAutocompletePicker, EntityAutocompletePickerProps, EntityErrorFilter, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityLoadingStatus, EntityNamespaceFilter, EntityNamespacePicker, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityOwnerPickerProps, EntityPeekAheadPopover, EntityPeekAheadPopoverProps, EntityProcessingStatusPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTagPickerProps, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MockEntityListContextProvider, MockStarredEntitiesApi, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, columnFactories, entityRouteParams, entityRouteRef, getEntityRelations, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useAsyncEntity, useEntity, useEntityList, useEntityOwnership, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };

package/dist/index.esm.js

@@ -2340,11 +2340,18 @@ const Contents = ({
   );
   const onDelete = useCallback(
     async function onDeleteFn() {
+      var _a2;
       if ("deleteEntity" in state) {
         setBusy(true);
         try {
           await state.deleteEntity();
+          const entityName = (_a2 = entity.metadata.title) != null ? _a2 : entity.metadata.name;
           onConfirm();
+          alertApi.post({
+            message: `Removed entity ${entityName}`,
+            severity: "success",
+            display: "transient"
+          });
         } catch (err) {
           assertError(err);
           alertApi.post({ message: err.message });
@@ -2353,7 +2360,7 @@ const Contents = ({
         }
       }
     },
-    [alertApi, onConfirm, state]
+    [alertApi, onConfirm, state, entity]
   );
   const DialogActionsPanel = () => /* @__PURE__ */ React.createElement(DialogActions, { className: classes.dialogActions }, /* @__PURE__ */ React.createElement(Button, { onClick: onClose, color: "primary" }, "Cancel"));
   if (state.type === "loading") {
@@ -2731,5 +2738,5 @@ function MockEntityListContextProvider(props) {
   return /* @__PURE__ */ React.createElement(EntityListContext.Provider, { value: resolvedValue }, children);
 }
 
-export { CatalogFilterLayout, EntityErrorFilter, EntityKindFilter, EntityKindPicker, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListProvider, EntityNamespaceFilter, EntityNamespacePicker, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityPeekAheadPopover, EntityProcessingStatusPicker, EntityRefLink, EntityRefLinks, EntitySearchBar, EntityTable, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, FavoriteEntity, InspectEntityDialog, MockEntityListContextProvider, MockStarredEntitiesApi, UnregisterEntityDialog, UserListFilter, UserListPicker, catalogApiRef, columnFactories, entityRouteParams, entityRouteRef, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useEntityList, useEntityOwnership, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };
+export { CatalogFilterLayout, EntityAutocompletePicker, EntityErrorFilter, EntityKindFilter, EntityKindPicker, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListProvider, EntityNamespaceFilter, EntityNamespacePicker, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityPeekAheadPopover, EntityProcessingStatusPicker, EntityRefLink, EntityRefLinks, EntitySearchBar, EntityTable, EntityTagFilter, EntityTagPicker, EntityTextFilter, EntityTypeFilter, EntityTypePicker, FavoriteEntity, InspectEntityDialog, MockEntityListContextProvider, MockStarredEntitiesApi, UnregisterEntityDialog, UserListFilter, UserListPicker, catalogApiRef, columnFactories, entityRouteParams, entityRouteRef, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useEntityList, useEntityOwnership, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };
 //# sourceMappingURL=index.esm.js.map