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

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/plugin-catalog-react
 
+## 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/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

package/alpha/package.json

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

package/dist/index.d.ts

@@ -7,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';
@@ -346,62 +346,6 @@ type CatalogReactEntityNamespacePickerClassKey = 'input';
 /** @public */
 declare const EntityNamespacePicker: () => React.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) => 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>;
-
 /**
  * Filter entities based on Kind.
  * @public
@@ -566,6 +510,83 @@ declare const EntityListProvider: <EntityFilters extends DefaultEntityFilters>(p
  */
 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.
@@ -683,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