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

package/CHANGELOG.md

@@ -1,5 +1,51 @@
 # @backstage/plugin-catalog-react
 
+## 1.10.0
+
+### Minor Changes
+
+- d208a93: Added support for server side text filtering to paginated entity requests.
+- 3dc64e9: Add support to `configSchema` option on the `createEntityCardExtension` factory function.
+
+### Patch Changes
+
+- 916da47: Change default icon for unknown entities to nothing instead of the help icon.
+- 71c6d7a: Overflowing labels in OwnerPicker (Catalog) are now truncated. Hovering over them shows the full label
+- 8fe56a8: Widen `@types/react` dependency range to include version 18.
+- 09cedb9: Updated dependency `@react-hookz/web` to `^24.0.0`.
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.6.0
+  - @backstage/core-components@0.14.0
+  - @backstage/catalog-model@1.4.4
+  - @backstage/core-plugin-api@1.9.0
+  - @backstage/catalog-client@1.6.0
+  - @backstage/plugin-permission-react@0.4.20
+  - @backstage/errors@1.2.3
+  - @backstage/integration-react@1.1.24
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+  - @backstage/plugin-catalog-common@1.0.21
+  - @backstage/plugin-permission-common@0.7.12
+
+## 1.10.0-next.3
+
+### Patch Changes
+
+- 09cedb9: Updated dependency `@react-hookz/web` to `^24.0.0`.
+- Updated dependencies
+  - @backstage/core-components@0.14.0-next.2
+  - @backstage/catalog-client@1.6.0-next.1
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/core-plugin-api@1.9.0-next.1
+  - @backstage/errors@1.2.3
+  - @backstage/frontend-plugin-api@0.6.0-next.3
+  - @backstage/integration-react@1.1.24-next.2
+  - @backstage/types@1.1.1
+  - @backstage/version-bridge@1.0.7
+  - @backstage/plugin-catalog-common@1.0.21-next.0
+  - @backstage/plugin-permission-common@0.7.12
+  - @backstage/plugin-permission-react@0.4.20-next.1
+
 ## 1.10.0-next.2
 
 ### Minor Changes

package/alpha/package.json

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

package/dist/index.d.ts

@@ -551,6 +551,10 @@ declare class EntityTextFilter implements EntityFilter {
     readonly value: string;
     constructor(value: string);
     filterEntity(entity: Entity): boolean;
+    getFullTextFilters(): {
+        term: string;
+        fields: string[];
+    };
     private toUpperArray;
 }
 /**

package/dist/index.esm.js

@@ -267,13 +267,22 @@ const CatalogFilterLayout = (props) => {
 CatalogFilterLayout.Filters = Filters;
 CatalogFilterLayout.Content = Content;
 
+function isEntityTextFilter(t) {
+  return !!t.getFullTextFilters;
+}
 function reduceCatalogFilters(filters) {
-  return filters.reduce((compoundFilter, filter) => {
-    return {
-      ...compoundFilter,
-      ...filter.getCatalogFilters ? filter.getCatalogFilters() : {}
-    };
-  }, {});
+  var _a;
+  const condensedFilters = filters.reduce(
+    (compoundFilter, filter) => {
+      return {
+        ...compoundFilter,
+        ...filter.getCatalogFilters ? filter.getCatalogFilters() : {}
+      };
+    },
+    {}
+  );
+  const fullTextFilter = (_a = filters.find(isEntityTextFilter)) == null ? void 0 : _a.getFullTextFilters();
+  return { filter: condensedFilters, fullTextFilter };
 }
 function reduceBackendCatalogFilters(filters) {
   const backendCatalogFilters = {};
@@ -377,6 +386,13 @@ class EntityTextFilter {
     }
     return true;
   }
+  getFullTextFilters() {
+    return {
+      term: this.value,
+      // Update this to be more dynamic based on table columns.
+      fields: ["metadata.name", "metadata.title", "spec.profile.displayName"]
+    };
+  }
   toUpperArray(value) {
     return value.flat().filter((m) => Boolean(m)).map((m) => m.toLocaleUpperCase("en-US"));
   }
@@ -603,7 +619,7 @@ const EntityListProvider = (props) => {
           );
           if (!isEqual(previousBackendFilter, backendFilter)) {
             const response = await catalogApi.queryEntities({
-              filter: backendFilter,
+              ...backendFilter,
               limit,
               orderFields: [{ field: "metadata.name", order: "asc" }]
             });
@@ -2742,7 +2758,7 @@ function useOwnedEntitiesCount() {
     []
   );
   const { user, owners, ...allFilters } = filters;
-  const { ["metadata.name"]: metadata, ...filter } = reduceCatalogFilters(
+  const catalogFilters = reduceCatalogFilters(
     compact(Object.values(allFilters))
   );
   const [{ value: count, loading: loadingEntityOwnership }, fetchEntities] = useAsyncFn(
@@ -2754,9 +2770,11 @@ function useOwnedEntitiesCount() {
       if (ownedClaims === void 0) {
         return 0;
       }
+      const { ["metadata.name"]: metadata, ...filter } = req.filter.filter;
       const { totalItems } = await catalogApi.queryEntities({
+        ...req.filter,
         filter: {
-          ...req.filter,
+          ...filter,
           "relations.ownedBy": ownedClaims
         },
         limit: 0
@@ -2767,14 +2785,18 @@ function useOwnedEntitiesCount() {
     { loading: true }
   );
   useDeepCompareEffect(() => {
-    if (Object.keys(filter).length === 0) {
+    if (Object.keys(catalogFilters.filter).length === 0) {
       return;
     }
     if (ownershipEntityRefs === void 0) {
       return;
     }
-    fetchEntities({ ownershipEntityRefs, owners, filter });
-  }, [ownershipEntityRefs, owners, filter]);
+    fetchEntities({
+      ownershipEntityRefs,
+      owners,
+      filter: catalogFilters
+    });
+  }, [ownershipEntityRefs, owners, catalogFilters]);
   const loading = loadingEntityRefs || loadingEntityOwnership;
   return {
     count,
@@ -2809,12 +2831,12 @@ function useAllEntitiesCount() {
   const request = useMemo(() => {
     const { user, ...allFilters } = filters;
     const compacted = compact(Object.values(allFilters));
-    const filter = reduceCatalogFilters(compacted);
+    const catalogFilters = reduceCatalogFilters(compacted);
     const newRequest = {
-      filter,
+      ...catalogFilters,
       limit: 0
     };
-    if (Object.keys(filter).length === 0) {
+    if (Object.keys(catalogFilters.filter).length === 0) {
       prevRequest.current = void 0;
       return prevRequest.current;
     }
@@ -2842,11 +2864,12 @@ function useStarredEntitiesCount() {
   const request = useMemo(() => {
     const { user, ...allFilters } = filters;
     const compacted = compact(Object.values(allFilters));
-    const filter2 = reduceCatalogFilters(compacted);
+    const catalogFilters = reduceCatalogFilters(compacted);
     const facet = "metadata.name";
     const newRequest = {
+      ...catalogFilters,
       filter: {
-        ...filter2,
+        ...catalogFilters.filter,
         /**
          * here we are filtering entities by `name`. Given this filter,
          * the response might contain more entities than expected, in case multiple entities