@backstage/plugin-catalog-react 1.4.1-next.1 → 1.5.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,62 @@
 # @backstage/plugin-catalog-react
 
+## 1.5.0-next.3
+
+### Minor Changes
+
+- a49fb39df5a: Attempt to load entity owner names in the EntityOwnerPicker through the `by-refs` endpoint. If `spec.profile.displayName` or `metadata.title` are populated, we now attempt to show those before showing the `humanizeEntityRef`'d version.
+
+  **BREAKING**: `EntityOwnerFilter` now uses the full entity ref instead of the `humanizeEntityRef`. If you rely on `EntityOwnerFilter.values` or the `queryParameters.owners` of `useEntityList`, you will need to adjust your code like the following.
+
+  ```tsx
+  const { queryParameters: { owners } } = useEntityList();
+  // or
+  const { filter: { owners } } = useEntityList();
+
+  // Instead of,
+  if (owners.some(ref => ref === humanizeEntityRef(myEntity))) ...
+
+  // You'll need to use,
+  if (owners.some(ref => ref === stringifyEntityRef(myEntity))) ...
+  ```
+
+### Patch Changes
+
+- d1f5324dff7: Reverted the check if the selected options list is different than the query parameters list before invoking `setSelectedOptions` method. This was preventing updating list items when a query string was already present in the URL when loading the page.
+- Updated dependencies
+  - @backstage/catalog-model@1.3.0-next.0
+  - @backstage/core-components@0.13.0-next.3
+  - @backstage/catalog-client@1.4.1-next.1
+  - @backstage/core-plugin-api@1.5.1-next.1
+  - @backstage/errors@1.1.5
+  - @backstage/integration@1.4.4-next.0
+  - @backstage/theme@0.2.19-next.0
+  - @backstage/types@1.0.2
+  - @backstage/version-bridge@1.0.4-next.0
+  - @backstage/plugin-catalog-common@1.0.13-next.1
+  - @backstage/plugin-permission-common@0.7.5-next.0
+  - @backstage/plugin-permission-react@0.4.12-next.1
+
+## 1.4.1-next.2
+
+### Patch Changes
+
+- 81bee24c5de: Fixed bug in catalog filters where you could not click on the text to select a value.
+- 2898b6c8d52: Minor type tweaks for TypeScript 5.0
+- Updated dependencies
+  - @backstage/catalog-client@1.4.1-next.0
+  - @backstage/core-components@0.12.6-next.2
+  - @backstage/core-plugin-api@1.5.1-next.1
+  - @backstage/catalog-model@1.2.1
+  - @backstage/errors@1.1.5
+  - @backstage/integration@1.4.4-next.0
+  - @backstage/theme@0.2.19-next.0
+  - @backstage/types@1.0.2
+  - @backstage/version-bridge@1.0.4-next.0
+  - @backstage/plugin-catalog-common@1.0.13-next.0
+  - @backstage/plugin-permission-common@0.7.5-next.0
+  - @backstage/plugin-permission-react@0.4.12-next.1
+
 ## 1.4.1-next.1
 
 ### Patch Changes

package/alpha/package.json

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

package/dist/index.d.ts

@@ -87,14 +87,14 @@ interface EntityKindPickerProps {
 declare const EntityKindPicker: (props: EntityKindPickerProps) => JSX.Element | null;
 
 /** @public */
-declare type CatalogReactEntityLifecyclePickerClassKey = 'input';
+type CatalogReactEntityLifecyclePickerClassKey = 'input';
 /** @public */
 declare const EntityLifecyclePicker: (props: {
     initialFilter?: string[];
 }) => JSX.Element | null;
 
 /** @public */
-declare type CatalogReactEntityOwnerPickerClassKey = 'input';
+type CatalogReactEntityOwnerPickerClassKey = 'input';
 /** @public */
 declare const EntityOwnerPicker: () => JSX.Element | null;
 
@@ -103,7 +103,7 @@ declare const EntityOwnerPicker: () => JSX.Element | null;
  *
  * @public
  */
-declare type EntityRefLinkProps = {
+type EntityRefLinkProps = {
     entityRef: Entity | CompoundEntityRef | string;
     defaultKind?: string;
     title?: string;
@@ -121,7 +121,7 @@ declare const EntityRefLink: (props: EntityRefLinkProps) => JSX.Element;
  *
  * @public
  */
-declare type EntityRefLinksProps<TRef extends string | CompoundEntityRef | Entity> = ({
+type EntityRefLinksProps<TRef extends string | CompoundEntityRef | Entity> = ({
     defaultKind?: string;
     entityRefs: TRef[];
     fetchEntities?: false;
@@ -154,7 +154,7 @@ declare function humanizeEntityRef(entityRef: Entity | CompoundEntityRef, opts?:
  *
  * @public
  */
-declare type EntityPeekAheadPopoverProps = PropsWithChildren<{
+type EntityPeekAheadPopoverProps = PropsWithChildren<{
     entityRef: string;
     delayTime?: number;
 }>;
@@ -166,7 +166,7 @@ declare type EntityPeekAheadPopoverProps = PropsWithChildren<{
 declare const EntityPeekAheadPopover: (props: EntityPeekAheadPopoverProps) => JSX.Element;
 
 /** @public */
-declare type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
+type CatalogReactEntitySearchBarClassKey = 'searchToolbar' | 'input';
 /**
  * Renders search bar for filtering the entity list.
  * @public
@@ -238,9 +238,9 @@ declare const columnFactories: Readonly<{
 }>;
 
 /** @public */
-declare type CatalogReactEntityTagPickerClassKey = 'input';
+type CatalogReactEntityTagPickerClassKey = 'input';
 /** @public */
-declare type EntityTagPickerProps = {
+type EntityTagPickerProps = {
     showCounts?: boolean;
 };
 /** @public */
@@ -259,7 +259,7 @@ interface EntityTypePickerProps {
 declare const EntityTypePicker: (props: EntityTypePickerProps) => JSX.Element | null;
 
 /** @public */
-declare type FavoriteEntityProps = ComponentProps<typeof IconButton> & {
+type FavoriteEntityProps = ComponentProps<typeof IconButton> & {
     entity: Entity;
 };
 /**
@@ -281,7 +281,7 @@ declare function InspectEntityDialog(props: {
 }): JSX.Element | null;
 
 /** @public */
-declare type UnregisterEntityDialogProps = {
+type UnregisterEntityDialogProps = {
     open: boolean;
     onConfirm: () => any;
     onClose: () => any;
@@ -291,7 +291,7 @@ declare type UnregisterEntityDialogProps = {
 declare const UnregisterEntityDialog: (props: UnregisterEntityDialogProps) => JSX.Element;
 
 /** @public */
-declare type EntityFilter = {
+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:
@@ -313,12 +313,12 @@ declare type EntityFilter = {
     toQueryValue?: () => string | string[];
 };
 /** @public */
-declare type UserListFilterKind = 'owned' | 'starred' | 'all';
+type UserListFilterKind = 'owned' | 'starred' | 'all';
 
 /** @public */
-declare type CatalogReactUserListPickerClassKey = 'root' | 'title' | 'listIcon' | 'menuItem' | 'groupWrapper';
+type CatalogReactUserListPickerClassKey = 'root' | 'title' | 'listIcon' | 'menuItem' | 'groupWrapper';
 /** @public */
-declare type UserListPickerProps = {
+type UserListPickerProps = {
     initialFilter?: UserListFilterKind;
     availableFilters?: UserListFilterKind[];
 };
@@ -326,12 +326,12 @@ declare type UserListPickerProps = {
 declare const UserListPicker: (props: UserListPickerProps) => JSX.Element;
 
 /** @public */
-declare type CatalogReactEntityProcessingStatusPickerClassKey = 'input';
+type CatalogReactEntityProcessingStatusPickerClassKey = 'input';
 /** @public */
 declare const EntityProcessingStatusPicker: () => JSX.Element;
 
 /** @public */
-declare type EntityLoadingStatus<TEntity extends Entity = Entity> = {
+type EntityLoadingStatus<TEntity extends Entity = Entity> = {
     entity?: TEntity;
     loading: boolean;
     error?: Error;
@@ -430,11 +430,17 @@ declare class EntityTextFilter implements EntityFilter {
 /**
  * Filter matching entities that are owned by group.
  * @public
+ *
+ * CAUTION: This class may contain both full and partial entity refs.
  */
 declare class EntityOwnerFilter implements EntityFilter {
     readonly values: string[];
     constructor(values: string[]);
     filterEntity(entity: Entity): boolean;
+    /**
+     * Get the URL query parameter value. May be a mix of full and humanized entity refs.
+     * @returns list of entity refs.
+     */
     toQueryValue(): string[];
 }
 /**
@@ -479,7 +485,7 @@ declare class EntityErrorFilter implements EntityFilter {
 }
 
 /** @public */
-declare type DefaultEntityFilters = {
+type DefaultEntityFilters = {
     kind?: EntityKindFilter;
     type?: EntityTypeFilter;
     user?: UserListFilter;
@@ -491,7 +497,7 @@ declare type DefaultEntityFilters = {
     error?: EntityErrorFilter;
 };
 /** @public */
-declare type EntityListContextProps<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters> = {
+type EntityListContextProps<EntityFilters extends DefaultEntityFilters = DefaultEntityFilters> = {
     /**
      * The currently registered filters, adhering to the shape of DefaultEntityFilters or an extension
      * of that default (to add custom filter types).
@@ -615,7 +621,7 @@ declare function MockEntityListContextProvider<T extends DefaultEntityFilters =
 }>): JSX.Element;
 
 /** @public */
-declare type CatalogReactComponentsNameToClassKey = {
+type CatalogReactComponentsNameToClassKey = {
     CatalogReactUserListPicker: CatalogReactUserListPickerClassKey;
     CatalogReactEntityLifecyclePicker: CatalogReactEntityLifecyclePickerClassKey;
     CatalogReactEntitySearchBar: CatalogReactEntitySearchBarClassKey;
@@ -624,7 +630,7 @@ declare type CatalogReactComponentsNameToClassKey = {
     CatalogReactEntityProcessingStatusPicker: CatalogReactEntityProcessingStatusPickerClassKey;
 };
 /** @public */
-declare type BackstageOverrides = Overrides & {
+type BackstageOverrides = Overrides & {
     [Name in keyof CatalogReactComponentsNameToClassKey]?: Partial<StyleRules<CatalogReactComponentsNameToClassKey[Name]>>;
 };
 
@@ -638,7 +644,7 @@ declare function getEntityRelations(entity: Entity | undefined, relationType: st
 }): CompoundEntityRef[];
 
 /** @public */
-declare type EntitySourceLocation = {
+type EntitySourceLocation = {
     locationTargetUrl: string;
     integrationType?: string;
 };