@backstage/plugin-catalog-react 1.10.1-next.1 → 1.11.0

package/CHANGELOG.md

@@ -1,5 +1,54 @@
 # @backstage/plugin-catalog-react
 
+## 1.11.0
+
+### Minor Changes
+
+- 72b8827: Number of results is now directly added as the field `totalItems` on `useEntityList`.
+
+### Patch Changes
+
+- 930b5c1: Added 'root' and 'label' class keys for EntityAutocompletePicker, EntityOwnerPicker and EntityProcessingStatusPicker
+- b2a9926: Adds an argument for which filters should be applied when fetching/counting available values
+- a6e237f: Added `DefaultFilters` component
+- 298953b: Added support for providing an `initiallySelectedNamespaces` which accepts an array of Namespaces to have selected by default
+- Updated dependencies
+  - @backstage/core-components@0.14.1
+  - @backstage/errors@1.2.4
+  - @backstage/integration-react@1.1.25
+  - @backstage/plugin-permission-common@0.7.13
+  - @backstage/catalog-client@1.6.1
+  - @backstage/catalog-model@1.4.5
+  - @backstage/core-plugin-api@1.9.1
+  - @backstage/frontend-plugin-api@0.6.1
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+  - @backstage/plugin-catalog-common@1.0.22
+  - @backstage/plugin-permission-react@0.4.21
+
+## 1.11.0-next.2
+
+### Minor Changes
+
+- 72b8827: Number of results is now directly added as the field `totalItems` on `useEntityList`.
+
+### Patch Changes
+
+- 298953b: Added support for providing an `initiallySelectedNamespaces` which accepts an array of Namespaces to have selected by default
+- Updated dependencies
+  - @backstage/core-components@0.14.1-next.2
+  - @backstage/catalog-client@1.6.1-next.1
+  - @backstage/integration-react@1.1.25-next.2
+  - @backstage/frontend-plugin-api@0.6.1-next.2
+  - @backstage/catalog-model@1.4.5-next.0
+  - @backstage/core-plugin-api@1.9.1-next.1
+  - @backstage/errors@1.2.4-next.0
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+  - @backstage/plugin-catalog-common@1.0.22-next.1
+  - @backstage/plugin-permission-common@0.7.13-next.1
+  - @backstage/plugin-permission-react@0.4.21-next.1
+
 ## 1.10.1-next.1
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/index.d.ts

@@ -255,6 +255,7 @@ type DefaultFiltersProps = {
     initialKind?: string;
     initiallySelectedFilter?: UserListFilterKind;
     ownerPickerMode?: EntityOwnerPickerProps['mode'];
+    initiallySelectedNamespaces?: string[];
 };
 /** @public */
 declare const DefaultFilters: (props: DefaultFiltersProps) => React.JSX.Element;
@@ -521,8 +522,16 @@ declare const EntityProcessingStatusPicker: () => React.JSX.Element;
 
 /** @public */
 type CatalogReactEntityNamespacePickerClassKey = 'input';
+/**
+ * Props for {@link EntityNamespacePicker}.
+ *
+ * @public
+ */
+interface EntityNamespacePickerProps {
+    initiallySelectedNamespaces?: string[];
+}
 /** @public */
-declare const EntityNamespacePicker: () => React.JSX.Element;
+declare const EntityNamespacePicker: (props: EntityNamespacePickerProps) => React.JSX.Element;
 
 /**
  * Filter entities based on Kind.
@@ -699,6 +708,7 @@ type EntityListContextProps<EntityFilters extends DefaultEntityFilters = Default
         next?: () => void;
         prev?: () => void;
     };
+    totalItems?: number;
 };
 /**
  * Creates new context for entity listing and filtering.
@@ -938,4 +948,4 @@ type EntitySourceLocation = {
 /** @public */
 declare function getEntitySourceLocation(entity: Entity, scmIntegrationsApi: typeof scmIntegrationsApiRef.T): EntitySourceLocation | undefined;
 
-export { AllowedEntityFilters, AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogFilterLayout, CatalogReactComponentsNameToClassKey, CatalogReactEntityAutocompletePickerClassKey, CatalogReactEntityDisplayNameClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityNamespacePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntityProcessingStatusPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, DefaultFilters, DefaultFiltersProps, EntityAutocompletePicker, EntityAutocompletePickerProps, EntityDisplayName, EntityDisplayNameProps, EntityErrorFilter, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityListProviderProps, EntityLoadingStatus, EntityNamespaceFilter, EntityNamespacePicker, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityOwnerPickerProps, EntityPeekAheadPopover, EntityPeekAheadPopoverProps, EntityPresentationApi, EntityProcessingStatusPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntityRefPresentation, EntityRefPresentationSnapshot, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTagPickerProps, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, EntityUserFilter, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MissingAnnotationEmptyState, MissingAnnotationEmptyStateClassKey, MockEntityListContextProvider, MockStarredEntitiesApi, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, columnFactories, defaultEntityPresentation, entityPresentationApiRef, entityRouteParams, entityRouteRef, getEntityRelations, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useAsyncEntity, useEntity, useEntityList, useEntityOwnership, useEntityPresentation, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };
+export { AllowedEntityFilters, AsyncEntityProvider, AsyncEntityProviderProps, BackstageOverrides, CatalogFilterLayout, CatalogReactComponentsNameToClassKey, CatalogReactEntityAutocompletePickerClassKey, CatalogReactEntityDisplayNameClassKey, CatalogReactEntityLifecyclePickerClassKey, CatalogReactEntityNamespacePickerClassKey, CatalogReactEntityOwnerPickerClassKey, CatalogReactEntityProcessingStatusPickerClassKey, CatalogReactEntitySearchBarClassKey, CatalogReactEntityTagPickerClassKey, CatalogReactUserListPickerClassKey, DefaultEntityFilters, DefaultFilters, DefaultFiltersProps, EntityAutocompletePicker, EntityAutocompletePickerProps, EntityDisplayName, EntityDisplayNameProps, EntityErrorFilter, EntityFilter, EntityKindFilter, EntityKindPicker, EntityKindPickerProps, EntityLifecycleFilter, EntityLifecyclePicker, EntityListContext, EntityListContextProps, EntityListProvider, EntityListProviderProps, EntityLoadingStatus, EntityNamespaceFilter, EntityNamespacePicker, EntityNamespacePickerProps, EntityOrphanFilter, EntityOwnerFilter, EntityOwnerPicker, EntityOwnerPickerProps, EntityPeekAheadPopover, EntityPeekAheadPopoverProps, EntityPresentationApi, EntityProcessingStatusPicker, EntityProvider, EntityProviderProps, EntityRefLink, EntityRefLinkProps, EntityRefLinks, EntityRefLinksProps, EntityRefPresentation, EntityRefPresentationSnapshot, EntitySearchBar, EntitySourceLocation, EntityTable, EntityTableProps, EntityTagFilter, EntityTagPicker, EntityTagPickerProps, EntityTextFilter, EntityTypeFilter, EntityTypePicker, EntityTypePickerProps, EntityUserFilter, FavoriteEntity, FavoriteEntityProps, InspectEntityDialog, MissingAnnotationEmptyState, MissingAnnotationEmptyStateClassKey, MockEntityListContextProvider, MockStarredEntitiesApi, StarredEntitiesApi, UnregisterEntityDialog, UnregisterEntityDialogProps, UserListFilter, UserListFilterKind, UserListPicker, UserListPickerProps, catalogApiRef, columnFactories, defaultEntityPresentation, entityPresentationApiRef, entityRouteParams, entityRouteRef, getEntityRelations, getEntitySourceLocation, humanizeEntityRef, starredEntitiesApiRef, useAsyncEntity, useEntity, useEntityList, useEntityOwnership, useEntityPresentation, useEntityTypeFilter, useRelatedEntities, useStarredEntities, useStarredEntity };

package/dist/index.esm.js

@@ -608,7 +608,8 @@ const EntityListProvider = (props) => {
               appliedCursor: cursor,
               backendEntities: response.items,
               entities: response.items.filter(entityFilter),
-              pageInfo: response.pageInfo
+              pageInfo: response.pageInfo,
+              totalItems: response.totalItems
             });
           }
         } else {
@@ -627,7 +628,8 @@ const EntityListProvider = (props) => {
               appliedFilters: requestedFilters,
               backendEntities: response.items,
               entities: response.items.filter(entityFilter),
-              pageInfo: response.pageInfo
+              pageInfo: response.pageInfo,
+              totalItems: response.totalItems
             });
           }
         }
@@ -641,16 +643,20 @@ const EntityListProvider = (props) => {
           const response = await catalogApi.getEntities({
             filter: backendFilter
           });
+          const entities = response.items.filter(entityFilter);
           setOutputState({
             appliedFilters: requestedFilters,
             backendEntities: response.items,
-            entities: response.items.filter(entityFilter)
+            entities,
+            totalItems: entities.length
           });
         } else {
+          const entities = outputState.backendEntities.filter(entityFilter);
           setOutputState({
             appliedFilters: requestedFilters,
             backendEntities: outputState.backendEntities,
-            entities: outputState.backendEntities.filter(entityFilter)
+            entities,
+            totalItems: entities.length
           });
         }
       }
@@ -708,7 +714,8 @@ const EntityListProvider = (props) => {
       queryParameters,
       loading,
       error,
-      pageInfo
+      pageInfo,
+      totalItems: outputState.totalItems
     }),
     [outputState, updateFilters, queryParameters, loading, error, pageInfo]
   );
@@ -1166,7 +1173,8 @@ const useStyles$f = makeStyles(
     name: "CatalogReactEntityNamespacePicker"
   }
 );
-const EntityNamespacePicker = () => {
+const EntityNamespacePicker = (props) => {
+  const { initiallySelectedNamespaces } = props;
   const classes = useStyles$f();
   return /* @__PURE__ */ React.createElement(
     EntityAutocompletePicker,
@@ -1175,7 +1183,8 @@ const EntityNamespacePicker = () => {
       name: "namespace",
       path: "metadata.namespace",
       Filter: EntityNamespaceFilter,
-      InputProps: { className: classes.input }
+      InputProps: { className: classes.input },
+      initialSelectedOptions: initiallySelectedNamespaces
     }
   );
 };
@@ -1998,8 +2007,18 @@ const UserListPicker = (props) => {
 };
 
 const DefaultFilters = (props) => {
-  const { initialKind, initiallySelectedFilter, ownerPickerMode } = props;
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(EntityKindPicker, { initialFilter: initialKind }), /* @__PURE__ */ React.createElement(EntityTypePicker, null), /* @__PURE__ */ React.createElement(UserListPicker, { initialFilter: initiallySelectedFilter }), /* @__PURE__ */ React.createElement(EntityOwnerPicker, { mode: ownerPickerMode }), /* @__PURE__ */ React.createElement(EntityLifecyclePicker, null), /* @__PURE__ */ React.createElement(EntityTagPicker, null), /* @__PURE__ */ React.createElement(EntityProcessingStatusPicker, null), /* @__PURE__ */ React.createElement(EntityNamespacePicker, null));
+  const {
+    initialKind,
+    initiallySelectedFilter,
+    ownerPickerMode,
+    initiallySelectedNamespaces
+  } = props;
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, /* @__PURE__ */ React.createElement(EntityKindPicker, { initialFilter: initialKind }), /* @__PURE__ */ React.createElement(EntityTypePicker, null), /* @__PURE__ */ React.createElement(UserListPicker, { initialFilter: initiallySelectedFilter }), /* @__PURE__ */ React.createElement(EntityOwnerPicker, { mode: ownerPickerMode }), /* @__PURE__ */ React.createElement(EntityLifecyclePicker, null), /* @__PURE__ */ React.createElement(EntityTagPicker, null), /* @__PURE__ */ React.createElement(EntityProcessingStatusPicker, null), /* @__PURE__ */ React.createElement(
+    EntityNamespacePicker,
+    {
+      initiallySelectedNamespaces
+    }
+  ));
 };
 
 const useStyles$a = makeStyles(
@@ -3285,7 +3304,7 @@ function MockEntityListContextProvider(props) {
   );
   const resolvedValue = useMemo(
     () => {
-      var _a2, _b, _c, _d, _e;
+      var _a2, _b, _c, _d, _e, _f, _g;
       return {
         entities: (_a2 = value == null ? void 0 : value.entities) != null ? _a2 : defaultValues.entities,
         backendEntities: (_b = value == null ? void 0 : value.backendEntities) != null ? _b : defaultValues.backendEntities,
@@ -3293,7 +3312,8 @@ function MockEntityListContextProvider(props) {
         filters,
         loading: (_d = value == null ? void 0 : value.loading) != null ? _d : false,
         queryParameters: (_e = value == null ? void 0 : value.queryParameters) != null ? _e : defaultValues.queryParameters,
-        error: value == null ? void 0 : value.error
+        error: value == null ? void 0 : value.error,
+        totalItems: (_g = value == null ? void 0 : value.totalItems) != null ? _g : ((_f = value == null ? void 0 : value.entities) != null ? _f : defaultValues.entities).length
       };
     },
     [value, defaultValues, filters, updateFilters]