@backstage/plugin-catalog-react 2.0.0-next.2 → 2.0.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,81 @@
 # @backstage/plugin-catalog-react
 
+## 2.0.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/ui@0.12.1-next.0
+  - @backstage/frontend-plugin-api@0.14.2-next.0
+  - @backstage/frontend-test-utils@0.5.1-next.0
+  - @backstage/catalog-client@1.13.1-next.0
+  - @backstage/catalog-model@1.7.6
+  - @backstage/core-compat-api@0.5.9-next.0
+  - @backstage/core-components@0.18.8-next.0
+  - @backstage/core-plugin-api@1.12.4-next.0
+  - @backstage/errors@1.2.7
+  - @backstage/filter-predicates@0.1.0
+  - @backstage/integration-react@1.2.16-next.0
+  - @backstage/types@1.2.2
+  - @backstage/version-bridge@1.0.12
+  - @backstage/plugin-catalog-common@1.1.8
+  - @backstage/plugin-permission-common@0.9.6
+  - @backstage/plugin-permission-react@0.4.41-next.0
+
+## 2.0.0
+
+### Minor Changes
+
+- 0e9578d: Migrated `UnregisterEntityDialog` from Material UI to Backstage UI components.
+- 491a06c: Add the ability to show icons for the tabs on the entity page (new frontend)
+- b4e8249: Implemented support for the new `queryLocations` and `streamLocations` that allow paginated/streamed and filtered location queries
+- 7feb83b: **BREAKING ALPHA**: All of the predicate types and functions have been moved to the `@backstage/filter-predicates` package.
+
+  When moving into the more general package, they were renamed as follows:
+
+  - `EntityPredicate` -> `FilterPredicate`
+  - `EntityPredicateExpression` -> `FilterPredicateExpression`
+  - `EntityPredicatePrimitive` -> `FilterPredicatePrimitive`
+  - `entityPredicateToFilterFunction` -> `filterPredicateToFilterFunction`
+  - `EntityPredicateValue` -> `FilterPredicateValue`
+
+- e8258d0: **BREAKING**: Removed the 'summary' entity card type from `EntityCardType`. Users should migrate to using 'content' or 'info' card types instead.
+
+  TypeScript will now show errors if you try to use `type: 'summary'` when creating entity cards.
+
+- ac9bead: Added `createTestEntityPage` test utility for testing entity cards and content extensions in the new frontend system. This utility creates a test page extension that provides `EntityProvider` context and accepts entity extensions through input redirects:
+
+  ```typescript
+  import { renderTestApp } from '@backstage/frontend-test-utils';
+  import { createTestEntityPage } from '@backstage/plugin-catalog-react/testUtils';
+
+  renderTestApp({
+    extensions: [createTestEntityPage({ entity: myEntity }), myEntityCard],
+  });
+  ```
+
+### Patch Changes
+
+- f523983: Fixes a bug where the `EntityListProvider` would not correctly hydrate query parameters if more than 20 were provided for the same key.
+- 09a6aad: The `catalogApiMock` test utility now returns a `MockWithApiFactory`, allowing it to be passed directly to test utilities like `renderTestApp` and `TestApiProvider` without needing the `[catalogApiRef, catalogApiMock()]` tuple.
+- 88dbd5e: fixed bug in `UserListPicker` by getting the `kindParamater` from the `filters` rather than from the `queryParameters`
+- a7e0d50: Updated `react-router-dom` peer dependency to `^6.30.2` and explicitly disabled v7 future flags to suppress deprecation warnings.
+- 69d880e: Bump to latest zod to ensure it has the latest features
+- Updated dependencies
+  - @backstage/ui@0.12.0
+  - @backstage/frontend-test-utils@0.5.0
+  - @backstage/core-components@0.18.7
+  - @backstage/core-compat-api@0.5.8
+  - @backstage/frontend-plugin-api@0.14.0
+  - @backstage/catalog-client@1.13.0
+  - @backstage/core-plugin-api@1.12.3
+  - @backstage/integration-react@1.2.15
+  - @backstage/plugin-permission-react@0.4.40
+  - @backstage/version-bridge@1.0.12
+  - @backstage/filter-predicates@0.1.0
+  - @backstage/plugin-permission-common@0.9.6
+  - @backstage/plugin-catalog-common@1.1.8
+
 ## 2.0.0-next.2
 
 ### Minor Changes

package/dist/alpha.d.ts

@@ -133,9 +133,9 @@ declare const EntityContentBlueprint: _backstage_frontend_plugin_api.ExtensionBl
         routeRef?: RouteRef;
         filter?: string | FilterPredicate | ((entity: Entity) => boolean);
     };
-    output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
+    output: _backstage_frontend_plugin_api.ExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
         optional: true;
-    }> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: Entity) => boolean, "catalog.entity-filter-function", {
+    }> | _backstage_frontend_plugin_api.ExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ExtensionDataRef<(entity: Entity) => boolean, "catalog.entity-filter-function", {
         optional: true;
     }> | _backstage_frontend_plugin_api.ExtensionDataRef<string, "catalog.entity-filter-expression", {
         optional: true;

package/dist/testUtils/catalogApiMock.esm.js

@@ -23,6 +23,8 @@ function catalogApiMock(options) {
     refreshEntity: jest.fn(),
     getEntityFacets: jest.fn(),
     getLocations: jest.fn(),
+    queryLocations: jest.fn(),
+    streamLocations: jest.fn(),
     getLocationById: jest.fn(),
     getLocationByRef: jest.fn(),
     addLocation: jest.fn(),

package/dist/testUtils/catalogApiMock.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"catalogApiMock.esm.js","sources":["../../src/testUtils/catalogApiMock.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiFactory, createApiFactory } from '@backstage/frontend-plugin-api';\nimport { InMemoryCatalogClient } from '@backstage/catalog-client/testUtils';\nimport { Entity } from '@backstage/catalog-model';\nimport { catalogApiRef } from '@backstage/plugin-catalog-react';\nimport { CatalogApi } from '@backstage/catalog-client';\nimport {\n  createApiMock,\n  attachMockApiFactory,\n  type MockWithApiFactory,\n} from '@backstage/frontend-test-utils';\n\n/**\n * Creates a fake catalog client that handles entities in memory storage. Note\n * that this client may be severely limited in functionality, and advanced\n * functions may not be available at all.\n *\n * @public\n */\nexport function catalogApiMock(options?: {\n  entities?: Entity[];\n}): MockWithApiFactory<CatalogApi> {\n  const instance = new InMemoryCatalogClient(options);\n  return attachMockApiFactory(catalogApiRef, instance);\n}\n\n/**\n * A collection of mock functionality for the catalog service.\n *\n * @public\n */\nexport namespace catalogApiMock {\n  /**\n   * Creates a fake catalog client that handles entities in memory storage. Note\n   * that this client may be severely limited in functionality, and advanced\n   * functions may not be available at all.\n   */\n  export const factory = (options?: {\n    entities?: Entity[];\n  }): ApiFactory<CatalogApi, CatalogApi, {}> =>\n    createApiFactory({\n      api: catalogApiRef,\n      deps: {},\n      factory: () => new InMemoryCatalogClient(options),\n    });\n  /**\n   * Creates a catalog client whose methods are mock functions, possibly with\n   * some of them overloaded by the caller.\n   */\n  export const mock = createApiMock(catalogApiRef, () => ({\n    getEntities: jest.fn(),\n    getEntitiesByRefs: jest.fn(),\n    queryEntities: jest.fn(),\n    getEntityAncestors: jest.fn(),\n    getEntityByRef: jest.fn(),\n    removeEntityByUid: jest.fn(),\n    refreshEntity: jest.fn(),\n    getEntityFacets: jest.fn(),\n    getLocations: jest.fn(),\n    getLocationById: jest.fn(),\n    getLocationByRef: jest.fn(),\n    addLocation: jest.fn(),\n    removeLocationById: jest.fn(),\n    getLocationByEntity: jest.fn(),\n    validateEntity: jest.fn(),\n    analyzeLocation: jest.fn(),\n    streamEntities: jest.fn(),\n    streamEntityPages: jest.fn(),\n  }));\n}\n"],"names":["catalogApiMock"],"mappings":";;;;;AAkCO,SAAS,eAAe,OAAA,EAEI;AACjC,EAAA,MAAM,QAAA,GAAW,IAAI,qBAAA,CAAsB,OAAO,CAAA;AAClD,EAAA,OAAO,oBAAA,CAAqB,eAAe,QAAQ,CAAA;AACrD;AAAA,CAOO,CAAUA,eAAAA,KAAV;AAME,EAAMA,eAAAA,CAAA,OAAA,GAAU,CAAC,OAAA,KAGtB,gBAAA,CAAiB;AAAA,IACf,GAAA,EAAK,aAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MAAM,IAAI,qBAAA,CAAsB,OAAO;AAAA,GACjD,CAAA;AAKI,EAAMA,eAAAA,CAAA,IAAA,GAAO,aAAA,CAAc,aAAA,EAAe,OAAO;AAAA,IACtD,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,IACrB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,IACvB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,IAC5B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,IACxB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,IACvB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,IACzB,YAAA,EAAc,KAAK,EAAA,EAAG;AAAA,IACtB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,IACzB,gBAAA,EAAkB,KAAK,EAAA,EAAG;AAAA,IAC1B,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,IACrB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,IAC5B,mBAAA,EAAqB,KAAK,EAAA,EAAG;AAAA,IAC7B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,IACxB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,IACzB,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,IACxB,iBAAA,EAAmB,KAAK,EAAA;AAAG,GAC7B,CAAE,CAAA;AAAA,CAAA,EArCa,cAAA,KAAA,cAAA,GAAA,EAAA,CAAA,CAAA;;;;"}
+{"version":3,"file":"catalogApiMock.esm.js","sources":["../../src/testUtils/catalogApiMock.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ApiFactory, createApiFactory } from '@backstage/frontend-plugin-api';\nimport { InMemoryCatalogClient } from '@backstage/catalog-client/testUtils';\nimport { Entity } from '@backstage/catalog-model';\nimport { catalogApiRef } from '@backstage/plugin-catalog-react';\nimport { CatalogApi } from '@backstage/catalog-client';\nimport {\n  createApiMock,\n  attachMockApiFactory,\n  type MockWithApiFactory,\n} from '@backstage/frontend-test-utils';\n\n/**\n * Creates a fake catalog client that handles entities in memory storage. Note\n * that this client may be severely limited in functionality, and advanced\n * functions may not be available at all.\n *\n * @public\n */\nexport function catalogApiMock(options?: {\n  entities?: Entity[];\n}): MockWithApiFactory<CatalogApi> {\n  const instance = new InMemoryCatalogClient(options);\n  return attachMockApiFactory(catalogApiRef, instance);\n}\n\n/**\n * A collection of mock functionality for the catalog service.\n *\n * @public\n */\nexport namespace catalogApiMock {\n  /**\n   * Creates a fake catalog client that handles entities in memory storage. Note\n   * that this client may be severely limited in functionality, and advanced\n   * functions may not be available at all.\n   */\n  export const factory = (options?: {\n    entities?: Entity[];\n  }): ApiFactory<CatalogApi, CatalogApi, {}> =>\n    createApiFactory({\n      api: catalogApiRef,\n      deps: {},\n      factory: () => new InMemoryCatalogClient(options),\n    });\n  /**\n   * Creates a catalog client whose methods are mock functions, possibly with\n   * some of them overloaded by the caller.\n   */\n  export const mock = createApiMock(catalogApiRef, () => ({\n    getEntities: jest.fn(),\n    getEntitiesByRefs: jest.fn(),\n    queryEntities: jest.fn(),\n    getEntityAncestors: jest.fn(),\n    getEntityByRef: jest.fn(),\n    removeEntityByUid: jest.fn(),\n    refreshEntity: jest.fn(),\n    getEntityFacets: jest.fn(),\n    getLocations: jest.fn(),\n    queryLocations: jest.fn(),\n    streamLocations: jest.fn(),\n    getLocationById: jest.fn(),\n    getLocationByRef: jest.fn(),\n    addLocation: jest.fn(),\n    removeLocationById: jest.fn(),\n    getLocationByEntity: jest.fn(),\n    validateEntity: jest.fn(),\n    analyzeLocation: jest.fn(),\n    streamEntities: jest.fn(),\n    streamEntityPages: jest.fn(),\n  }));\n}\n"],"names":["catalogApiMock"],"mappings":";;;;;AAkCO,SAAS,eAAe,OAAA,EAEI;AACjC,EAAA,MAAM,QAAA,GAAW,IAAI,qBAAA,CAAsB,OAAO,CAAA;AAClD,EAAA,OAAO,oBAAA,CAAqB,eAAe,QAAQ,CAAA;AACrD;AAAA,CAOO,CAAUA,eAAAA,KAAV;AAME,EAAMA,eAAAA,CAAA,OAAA,GAAU,CAAC,OAAA,KAGtB,gBAAA,CAAiB;AAAA,IACf,GAAA,EAAK,aAAA;AAAA,IACL,MAAM,EAAC;AAAA,IACP,OAAA,EAAS,MAAM,IAAI,qBAAA,CAAsB,OAAO;AAAA,GACjD,CAAA;AAKI,EAAMA,eAAAA,CAAA,IAAA,GAAO,aAAA,CAAc,aAAA,EAAe,OAAO;AAAA,IACtD,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,IACrB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,IACvB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,IAC5B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,IACxB,iBAAA,EAAmB,KAAK,EAAA,EAAG;AAAA,IAC3B,aAAA,EAAe,KAAK,EAAA,EAAG;AAAA,IACvB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,IACzB,YAAA,EAAc,KAAK,EAAA,EAAG;AAAA,IACtB,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,IACxB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,IACzB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,IACzB,gBAAA,EAAkB,KAAK,EAAA,EAAG;AAAA,IAC1B,WAAA,EAAa,KAAK,EAAA,EAAG;AAAA,IACrB,kBAAA,EAAoB,KAAK,EAAA,EAAG;AAAA,IAC5B,mBAAA,EAAqB,KAAK,EAAA,EAAG;AAAA,IAC7B,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,IACxB,eAAA,EAAiB,KAAK,EAAA,EAAG;AAAA,IACzB,cAAA,EAAgB,KAAK,EAAA,EAAG;AAAA,IACxB,iBAAA,EAAmB,KAAK,EAAA;AAAG,GAC7B,CAAE,CAAA;AAAA,CAAA,EAvCa,cAAA,KAAA,cAAA,GAAA,EAAA,CAAA,CAAA;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-catalog-react",
-  "version": "2.0.0-next.2",
+  "version": "2.0.1-next.0",
   "description": "A frontend library that helps other Backstage plugins interact with the catalog",
   "backstage": {
     "role": "web-library",
@@ -73,21 +73,21 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/catalog-client": "1.12.2-next.0",
+    "@backstage/catalog-client": "1.13.1-next.0",
     "@backstage/catalog-model": "1.7.6",
-    "@backstage/core-compat-api": "0.5.8-next.2",
-    "@backstage/core-components": "0.18.7-next.2",
-    "@backstage/core-plugin-api": "1.12.3-next.1",
+    "@backstage/core-compat-api": "0.5.9-next.0",
+    "@backstage/core-components": "0.18.8-next.0",
+    "@backstage/core-plugin-api": "1.12.4-next.0",
     "@backstage/errors": "1.2.7",
-    "@backstage/filter-predicates": "0.1.0-next.0",
-    "@backstage/frontend-plugin-api": "0.14.0-next.2",
-    "@backstage/integration-react": "1.2.15-next.2",
-    "@backstage/plugin-catalog-common": "1.1.8-next.0",
-    "@backstage/plugin-permission-common": "0.9.6-next.0",
-    "@backstage/plugin-permission-react": "0.4.40-next.1",
+    "@backstage/filter-predicates": "0.1.0",
+    "@backstage/frontend-plugin-api": "0.14.2-next.0",
+    "@backstage/integration-react": "1.2.16-next.0",
+    "@backstage/plugin-catalog-common": "1.1.8",
+    "@backstage/plugin-permission-common": "0.9.6",
+    "@backstage/plugin-permission-react": "0.4.41-next.0",
     "@backstage/types": "1.2.2",
-    "@backstage/ui": "0.12.0-next.2",
-    "@backstage/version-bridge": "1.0.12-next.0",
+    "@backstage/ui": "0.12.1-next.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",
@@ -101,12 +101,12 @@
     "zen-observable": "^0.10.0"
   },
   "devDependencies": {
-    "@backstage/cli": "0.35.4-next.2",
-    "@backstage/core-app-api": "1.19.5-next.1",
-    "@backstage/frontend-test-utils": "0.5.0-next.2",
-    "@backstage/plugin-catalog-common": "1.1.8-next.0",
-    "@backstage/plugin-scaffolder-common": "1.7.6-next.1",
-    "@backstage/test-utils": "1.7.15-next.2",
+    "@backstage/cli": "0.35.5-next.0",
+    "@backstage/core-app-api": "1.19.6-next.0",
+    "@backstage/frontend-test-utils": "0.5.1-next.0",
+    "@backstage/plugin-catalog-common": "1.1.8",
+    "@backstage/plugin-scaffolder-common": "1.7.7-next.0",
+    "@backstage/test-utils": "1.7.16-next.0",
     "@testing-library/dom": "^10.0.0",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",
@@ -120,7 +120,7 @@
     "zod": "^3.25.76"
   },
   "peerDependencies": {
-    "@backstage/frontend-test-utils": "0.5.0-next.2",
+    "@backstage/frontend-test-utils": "0.5.1-next.0",
     "@types/react": "^17.0.0 || ^18.0.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0",