@backstage/plugin-catalog-react 3.3.0-next.2 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # @backstage/plugin-catalog-react
 
+## 3.3.0
+
+### Minor Changes
+
+- 6c74f3f: Added `getCatalogQuery` to `EntityFilter`, which lets filters express their backend constraints as a filter predicate. This supports logical operators such as `$any` and `$not`, as well as matchers like `$hasPrefix`, that cannot be expressed with `getCatalogFilters`. All builtin filters now implement it, and `getCatalogFilters` is deprecated. If a filter implements both, only `getCatalogQuery` is used.
+
+  The `EntityListProvider` and related components combine the predicates of all active filters into a `query`, and send it to the catalog backend alongside a `filter` built from any remaining legacy filters. When not paginating, entities are now fetched using `streamEntities` instead of `getEntities`, since the latter does not support predicate queries. Tests that mock `getEntities` to provide entities to an `EntityListProvider` need to mock `streamEntities` instead.
+
+  This requires a catalog backend from Backstage release 1.49 or later, which added support for predicate queries.
+
+  Since entities are now fetched using `queryEntities` also when not paginating, an `EntityOrderFilter` that orders by a field that some entities lack now excludes those entities from the result, consistent with paginated mode. Previously they were placed last.
+
+  Some builtin filters became more precise as part of this change:
+
+  - `EntityTagFilter` with multiple tags now requires all of them on the backend, matching its frontend behavior.
+  - `EntityUserFilter.starred` matches the full starred entity refs rather than just their names, and the starred count is computed by the backend.
+
+### Patch Changes
+
+- c162b94: Fixed the catalog entity list re-writing the URL on every render, which spammed `history.replaceState` and crashed Safari with a `SecurityError`. The URL is now only updated when it actually changes.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.18.2
+  - @backstage/ui@0.19.0
+  - @backstage/catalog-client@1.16.3
+  - @backstage/core-compat-api@0.5.16
+  - @backstage/errors@1.3.2
+  - @backstage/filter-predicates@0.2.0
+  - @backstage/core-components@0.18.15
+  - @backstage/catalog-model@1.10.2
+  - @backstage/core-plugin-api@1.12.11
+  - @backstage/integration-react@1.2.23
+  - @backstage/plugin-permission-common@0.9.12
+  - @backstage/plugin-permission-react@0.5.6
+
 ## 3.3.0-next.2
 
 ### Minor Changes

package/dist/alpha.d.ts

@@ -104,11 +104,11 @@ declare const EntityCardBlueprint: _backstage_frontend_plugin_api.ExtensionBluep
     }>;
     inputs: {};
     config: {
-        filter: FilterPredicate | undefined;
+        filter: string | FilterPredicate | undefined;
         type: "content" | "info" | undefined;
     };
     configInput: {
-        filter?: FilterPredicate | undefined;
+        filter?: string | FilterPredicate | undefined;
         type?: "content" | "info" | undefined;
     };
     dataRefs: {
@@ -160,14 +160,14 @@ declare const EntityContentBlueprint: _backstage_frontend_plugin_api.ExtensionBl
     config: {
         path: string | undefined;
         title: string | undefined;
-        filter: FilterPredicate | undefined;
+        filter: string | FilterPredicate | undefined;
         group: string | false | undefined;
         icon: string | undefined;
     };
     configInput: {
         path?: string | undefined;
         title?: string | undefined;
-        filter?: FilterPredicate | undefined;
+        filter?: string | FilterPredicate | undefined;
         group?: string | false | undefined;
         icon?: string | undefined;
     };
@@ -202,11 +202,11 @@ declare const EntityContentLayoutBlueprint: _backstage_frontend_plugin_api.Exten
     inputs: {};
     config: {
         type: string | undefined;
-        filter: FilterPredicate | undefined;
+        filter: string | FilterPredicate | undefined;
     };
     configInput: {
         type?: string | undefined;
-        filter?: FilterPredicate | undefined;
+        filter?: string | FilterPredicate | undefined;
     };
     dataRefs: {
         filterFunction: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: Entity) => boolean, "catalog.entity-filter-function", {}>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "3.3.0-next.2",
+  "version": "3.3.0",
   "description": "A frontend library that helps other Backstage plugins interact with the catalog",
   "backstage": {
     "role": "web-library",
@@ -73,20 +73,20 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "1.16.3-next.1",
-    "@backstage/catalog-model": "1.10.2-next.0",
-    "@backstage/core-compat-api": "0.5.16-next.1",
-    "@backstage/core-components": "0.18.15-next.3",
-    "@backstage/core-plugin-api": "1.12.11-next.0",
-    "@backstage/errors": "1.3.2-next.0",
-    "@backstage/filter-predicates": "0.1.6-next.0",
-    "@backstage/frontend-plugin-api": "0.18.2-next.1",
-    "@backstage/integration-react": "1.2.23-next.0",
-    "@backstage/plugin-permission-common": "0.9.12-next.0",
-    "@backstage/plugin-permission-react": "0.5.6-next.0",
-    "@backstage/types": "1.2.2",
-    "@backstage/ui": "0.19.0-next.0",
-    "@backstage/version-bridge": "1.0.12",
+    "@backstage/catalog-client": "^1.16.3",
+    "@backstage/catalog-model": "^1.10.2",
+    "@backstage/core-compat-api": "^0.5.16",
+    "@backstage/core-components": "^0.18.15",
+    "@backstage/core-plugin-api": "^1.12.11",
+    "@backstage/errors": "^1.3.2",
+    "@backstage/filter-predicates": "^0.2.0",
+    "@backstage/frontend-plugin-api": "^0.18.2",
+    "@backstage/integration-react": "^1.2.23",
+    "@backstage/plugin-permission-common": "^0.9.12",
+    "@backstage/plugin-permission-react": "^0.5.6",
+    "@backstage/types": "^1.2.2",
+    "@backstage/ui": "^0.19.0",
+    "@backstage/version-bridge": "^1.0.12",
     "@material-ui/core": "^4.12.2",
     "@material-ui/icons": "^4.9.1",
     "@material-ui/lab": "4.0.0-alpha.61",
@@ -104,12 +104,12 @@
     "zod": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.36.7-next.0",
-    "@backstage/core-app-api": "1.20.6-next.1",
-    "@backstage/frontend-test-utils": "0.6.5-next.0",
-    "@backstage/plugin-catalog-common": "1.2.1-next.0",
-    "@backstage/plugin-scaffolder-common": "2.3.1-next.0",
-    "@backstage/test-utils": "1.7.23-next.0",
+    "@backstage/cli": "^0.36.7",
+    "@backstage/core-app-api": "^1.20.6",
+    "@backstage/frontend-test-utils": "^0.6.5",
+    "@backstage/plugin-catalog-common": "^1.2.1",
+    "@backstage/plugin-scaffolder-common": "^2.3.1",
+    "@backstage/test-utils": "^1.7.23",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
@@ -123,7 +123,7 @@
     "react-test-renderer": "^16.13.1"
   },
   "peerDependencies": {
-    "@backstage/frontend-test-utils": "0.6.5-next.0",
+    "@backstage/frontend-test-utils": "^0.6.5",
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0",