From b3ef24038b6a896017685e679a1b6623d5e40201 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 24 Feb 2022 09:58:49 +0100 Subject: [PATCH 1/2] catalog-react: Deprecate reduceCatalogFilters and reduceEntityFilters Signed-off-by: Johan Haals --- .changeset/orange-cups-smoke.md | 5 +++++ plugins/catalog-react/src/utils/filters.ts | 10 ++++++++-- 2 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 .changeset/orange-cups-smoke.md diff --git a/.changeset/orange-cups-smoke.md b/.changeset/orange-cups-smoke.md new file mode 100644 index 0000000000..2876c9c396 --- /dev/null +++ b/.changeset/orange-cups-smoke.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-react': patch +--- + +Deprecated `reduceCatalogFilters` and `reduceEntityFilters` as these helper functions are used internally and provides low external value. diff --git a/plugins/catalog-react/src/utils/filters.ts b/plugins/catalog-react/src/utils/filters.ts index d64a821df7..68cd94fd6e 100644 --- a/plugins/catalog-react/src/utils/filters.ts +++ b/plugins/catalog-react/src/utils/filters.ts @@ -17,7 +17,10 @@ import { Entity } from '@backstage/catalog-model'; import { EntityFilter } from '../types'; -/** @public */ +/** + * @public + * @deprecated will be made private. + */ export function reduceCatalogFilters( filters: EntityFilter[], ): Record { @@ -29,7 +32,10 @@ export function reduceCatalogFilters( }, {} as Record); } -/** @public */ +/** + * @public + * @deprecated will be made private. + */ export function reduceEntityFilters( filters: EntityFilter[], ): (entity: Entity) => boolean { From 1210f9cb09e4bcf066673e37b5250360ffaa20d7 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Thu, 24 Feb 2022 10:41:26 +0100 Subject: [PATCH 2/2] Update API report Signed-off-by: Johan Haals --- plugins/catalog-react/api-report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index 7e6b80bd19..33580ae40a 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -488,12 +488,12 @@ export const MockEntityListContextProvider: ({ value?: Partial> | undefined; }>) => JSX.Element; -// @public (undocumented) +// @public @deprecated (undocumented) export function reduceCatalogFilters( filters: EntityFilter[], ): Record; -// @public (undocumented) +// @public @deprecated (undocumented) export function reduceEntityFilters( filters: EntityFilter[], ): (entity: Entity) => boolean;