use more sensible property for specifying the relationship type

In the process, the `relationsType` prop is deprecated and renamed to
`relationAggregation`.

Signed-off-by: Brian Phillips <28457+brianphillips@users.noreply.github.com>
This commit is contained in:
Brian Phillips
2024-06-06 06:37:35 -05:00
parent 05ad87ed3a
commit 0391e693ba
2 changed files with 12 additions and 9 deletions
@@ -160,7 +160,7 @@ describe('MemberTab Test', () => {
await renderInTestApp(
<TestApiProvider apis={[[catalogApiRef, catalogApi]]}>
<EntityProvider entity={groupEntity}>
<MembersListCard relationship="leaderOf" />
<MembersListCard relationType="leaderOf" />
</EntityProvider>
</TestApiProvider>,
{
@@ -376,7 +376,7 @@ describe('MemberTab Test', () => {
<EntityLayout.Route path="/" title="Title">
<MembersListCard
showAggregateMembersToggle
relationsType="aggregated"
relationAggregation="aggregated"
/>
</EntityLayout.Route>
</EntityLayout>
@@ -414,7 +414,7 @@ describe('MemberTab Test', () => {
<EntityProvider entity={groupA}>
<EntityLayout>
<EntityLayout.Route path="/" title="Title">
<MembersListCard relationsType="aggregated" />
<MembersListCard relationAggregation="aggregated" />
</EntityLayout.Route>
</EntityLayout>
</EntityProvider>
@@ -138,16 +138,19 @@ export const MembersListCard = (props: {
memberDisplayTitle?: string;
pageSize?: number;
showAggregateMembersToggle?: boolean;
relationship?: string;
relationType?: string;
/** @deprecated Please use `relationAggregation` instead */
relationsType?: EntityRelationAggregation;
relationAggregation?: EntityRelationAggregation;
}) => {
const {
memberDisplayTitle = 'Members',
pageSize = 50,
showAggregateMembersToggle,
relationship = 'memberof',
relationsType = 'direct',
relationType = 'memberof',
} = props;
const relationAggregation =
props.relationAggregation ?? props.relationsType ?? 'direct';
const classes = useListStyles();
const { entity: groupEntity } = useEntity<GroupEntity>();
@@ -167,7 +170,7 @@ export const MembersListCard = (props: {
};
const [showAggregateMembers, setShowAggregateMembers] = useState(
relationsType === 'aggregated',
relationAggregation === 'aggregated',
);
const { loading: loadingDescendantMembers, value: descendantMembers } =
@@ -179,7 +182,7 @@ export const MembersListCard = (props: {
return await getAllDesendantMembersForGroupEntity(
groupEntity,
catalogApi,
relationship,
relationType,
);
}, [catalogApi, groupEntity, showAggregateMembers]);
const {
@@ -190,7 +193,7 @@ export const MembersListCard = (props: {
const membersList = await catalogApi.getEntities({
filter: {
kind: 'User',
[`relations.${relationship.toLocaleLowerCase('en-US')}`]: [
[`relations.${relationType.toLocaleLowerCase('en-US')}`]: [
stringifyEntityRef({
kind: 'group',
namespace: groupNamespace.toLocaleLowerCase('en-US'),