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

package/CHANGELOG.md

@@ -1,5 +1,48 @@
 # @backstage/plugin-catalog-react
 
+## 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
+
+- b2a9926: Adds an argument for which filters should be applied when fetching/counting available values
+- a6e237f: Added `DefaultFilters` component
+- Updated dependencies
+  - @backstage/core-components@0.14.1-next.1
+  - @backstage/core-plugin-api@1.9.1-next.1
+  - @backstage/integration-react@1.1.25-next.1
+  - @backstage/plugin-permission-common@0.7.13-next.1
+  - @backstage/plugin-permission-react@0.4.21-next.1
+  - @backstage/frontend-plugin-api@0.6.1-next.1
+  - @backstage/catalog-client@1.6.1-next.0
+  - @backstage/catalog-model@1.4.5-next.0
+  - @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
+
 ## 1.10.1-next.0
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/index.d.ts

@@ -210,6 +210,56 @@ declare const CatalogFilterLayout: {
     }) => React.JSX.Element;
 };
 
+/** @public */
+type EntityFilter = {
+    /**
+     * Get filters to add to the catalog-backend request. These are a dot-delimited field with
+     * value(s) to accept, extracted on the backend by parseEntityFilterParams. For example:
+     *   `{ field: 'kind', values: ['component'] }`
+     *   `{ field: 'metadata.name', values: ['component-1', 'component-2'] }`
+     */
+    getCatalogFilters?: () => Record<string, string | symbol | (string | symbol)[]>;
+    /**
+     * Filter entities on the frontend after a catalog-backend request. This function will be called
+     * with each backend-resolved entity. This is used when frontend information is required for
+     * filtering, such as a user's starred entities.
+     */
+    filterEntity?: (entity: Entity) => boolean;
+    /**
+     * Serialize the filter value to a string for query params. The UI component responsible for
+     * handling this filter should retrieve this from useEntityList.queryParameters. The
+     * value restored should be in the precedence: queryParameters `>` initialValue prop `>` default.
+     */
+    toQueryValue?: () => string | string[];
+};
+/** @public */
+type UserListFilterKind = 'owned' | 'starred' | 'all';
+
+/** @public */
+type CatalogReactEntityOwnerPickerClassKey = 'input';
+/**
+ * @public
+ */
+type EntityOwnerPickerProps = {
+    mode?: 'owners-only' | 'all';
+};
+/** @public */
+declare const EntityOwnerPicker: (props?: EntityOwnerPickerProps) => React.JSX.Element | null;
+
+/**
+ * Props for default filters.
+ *
+ * @public
+ */
+type DefaultFiltersProps = {
+    initialKind?: string;
+    initiallySelectedFilter?: UserListFilterKind;
+    ownerPickerMode?: EntityOwnerPickerProps['mode'];
+    initiallySelectedNamespaces?: string[];
+};
+/** @public */
+declare const DefaultFilters: (props: DefaultFiltersProps) => React.JSX.Element;
+
 /**
  * Props for {@link EntityKindPicker}.
  *
@@ -234,17 +284,6 @@ declare const EntityLifecyclePicker: (props: {
     initialFilter?: string[];
 }) => React.JSX.Element;
 
-/** @public */
-type CatalogReactEntityOwnerPickerClassKey = 'input';
-/**
- * @public
- */
-type EntityOwnerPickerProps = {
-    mode?: 'owners-only' | 'all';
-};
-/** @public */
-declare const EntityOwnerPicker: (props?: EntityOwnerPickerProps) => React.JSX.Element | null;
-
 /**
  * The available style class keys for {@link EntityDisplayName}, under the name
  * "CatalogReactEntityDisplayName".
@@ -466,31 +505,6 @@ type UnregisterEntityDialogProps = {
 /** @public */
 declare const UnregisterEntityDialog: (props: UnregisterEntityDialogProps) => React.JSX.Element;
 
-/** @public */
-type EntityFilter = {
-    /**
-     * Get filters to add to the catalog-backend request. These are a dot-delimited field with
-     * value(s) to accept, extracted on the backend by parseEntityFilterParams. For example:
-     *   `{ field: 'kind', values: ['component'] }`
-     *   `{ field: 'metadata.name', values: ['component-1', 'component-2'] }`
-     */
-    getCatalogFilters?: () => Record<string, string | symbol | (string | symbol)[]>;
-    /**
-     * Filter entities on the frontend after a catalog-backend request. This function will be called
-     * with each backend-resolved entity. This is used when frontend information is required for
-     * filtering, such as a user's starred entities.
-     */
-    filterEntity?: (entity: Entity) => boolean;
-    /**
-     * Serialize the filter value to a string for query params. The UI component responsible for
-     * handling this filter should retrieve this from useEntityList.queryParameters. The
-     * value restored should be in the precedence: queryParameters `>` initialValue prop `>` default.
-     */
-    toQueryValue?: () => string | string[];
-};
-/** @public */
-type UserListFilterKind = 'owned' | 'starred' | 'all';
-
 /** @public */
 type CatalogReactUserListPickerClassKey = 'root' | 'title' | 'listIcon' | 'menuItem' | 'groupWrapper';
 /** @public */
@@ -508,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.
@@ -686,6 +708,7 @@ type EntityListContextProps<EntityFilters extends DefaultEntityFilters = Default
         next?: () => void;
         prev?: () => void;
     };
+    totalItems?: number;
 };
 /**
  * Creates new context for entity listing and filtering.
@@ -728,6 +751,7 @@ type EntityAutocompletePickerProps<T extends DefaultEntityFilters = DefaultEntit
     };
     InputProps?: TextFieldProps;
     initialSelectedOptions?: string[];
+    filtersForAvailableValues?: Array<keyof T>;
 };
 /** @public */
 type CatalogReactEntityAutocompletePickerClassKey = 'root' | 'label';
@@ -924,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, 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 };