@backstage/plugin-org 0.7.1-next.2 → 0.7.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/components/Cards/Group/MembersList/MembersListCard.esm.js +2 -2
- package/dist/components/Cards/Group/MembersList/MembersListCard.esm.js.map +1 -1
- package/dist/components/Cards/OwnershipCard/useGetEntities.esm.js +3 -3
- package/dist/components/Cards/OwnershipCard/useGetEntities.esm.js.map +1 -1
- package/dist/package.json.esm.js +1 -1
- package/package.json +18 -18
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,22 @@
|
|
|
1
1
|
# @backstage/plugin-org
|
|
2
2
|
|
|
3
|
+
## 0.7.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 64c9a20: The `MembersListCard` now prefers `metadata.title` over `metadata.name` when displaying the group membership card, similarly to the rest of the group profile cards
|
|
8
|
+
- 87eb31c: Fixed `GroupProfileCard` and `UserProfileCard` content overflowing on narrow screens.
|
|
9
|
+
- d156cf4: Added `title` and `icon` to the new frontend system plugin definition.
|
|
10
|
+
- f1f59b1: Replaced deprecated `humanizeEntityRef` usage with the Catalog Presentation API.
|
|
11
|
+
- Updated dependencies
|
|
12
|
+
- @backstage/ui@0.14.0
|
|
13
|
+
- @backstage/catalog-model@1.8.0
|
|
14
|
+
- @backstage/plugin-catalog-react@2.1.2
|
|
15
|
+
- @backstage/frontend-plugin-api@0.16.0
|
|
16
|
+
- @backstage/core-components@0.18.9
|
|
17
|
+
- @backstage/core-plugin-api@1.12.5
|
|
18
|
+
- @backstage/plugin-catalog-common@1.1.9
|
|
19
|
+
|
|
3
20
|
## 0.7.1-next.2
|
|
4
21
|
|
|
5
22
|
### Patch Changes
|
|
@@ -111,11 +111,11 @@ const MembersListCard = (props) => {
|
|
|
111
111
|
const classes = useListStyles();
|
|
112
112
|
const { entity: groupEntity } = useEntity();
|
|
113
113
|
const {
|
|
114
|
-
metadata: { name: groupName, namespace: grpNamespace },
|
|
114
|
+
metadata: { name: groupName, namespace: grpNamespace, title: groupTitle },
|
|
115
115
|
spec: { profile }
|
|
116
116
|
} = groupEntity;
|
|
117
117
|
const catalogApi = useApi(catalogApiRef);
|
|
118
|
-
const displayName = profile?.displayName ?? groupName;
|
|
118
|
+
const displayName = profile?.displayName ?? groupTitle ?? groupName;
|
|
119
119
|
const cardTitle = memberDisplayTitle ?? t("membersListCard.title", { groupName: displayName });
|
|
120
120
|
const groupNamespace = grpNamespace || DEFAULT_NAMESPACE;
|
|
121
121
|
const [offset, setOffset] = useState(0);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"MembersListCard.esm.js","sources":["../../../../../src/components/Cards/Group/MembersList/MembersListCard.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 {\n DEFAULT_NAMESPACE,\n GroupEntity,\n UserEntity,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n catalogApiRef,\n useEntity,\n EntityInfoCard,\n useEntityRefLink,\n} from '@backstage/plugin-catalog-react';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { useState, useEffect } from 'react';\nimport useAsync from 'react-use/esm/useAsync';\n\nimport { Progress, ResponseErrorPanel } from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\nimport {\n getAllDesendantMembersForGroupEntity,\n removeDuplicateEntitiesFrom,\n} from '../../../../helpers/helpers';\nimport { EntityRelationAggregation } from '../../types';\nimport { useTranslationRef } from '@backstage/frontend-plugin-api';\nimport { orgTranslationRef } from '../../../../translation';\nimport {\n Avatar,\n Box,\n Card,\n Flex,\n Link,\n SearchField,\n Switch,\n TablePagination,\n Text,\n} from '@backstage/ui';\n\nconst useMemberStyles = makeStyles({\n card: {\n display: 'flex',\n gap: 'var(--bui-space-3)',\n padding: 'var(--bui-space-3)',\n alignItems: 'flex-start',\n flexDirection: 'row',\n height: 140,\n overflow: 'hidden',\n },\n avatar: {\n flexShrink: 0,\n },\n cardTextContainer: {\n overflow: 'hidden',\n },\n singlelineEllipsis: {\n overflow: 'hidden',\n textOverflow: 'ellipsis',\n whiteSpace: 'nowrap',\n },\n multilineEllipsis: {\n display: '-webkit-box',\n '-webkit-line-clamp': '3',\n '-webkit-box-orient': 'vertical',\n overflow: 'hidden',\n },\n});\n\nconst MemberComponent = (props: { member: UserEntity }) => {\n const { t } = useTranslationRef(orgTranslationRef);\n const classes = useMemberStyles();\n const {\n metadata: { name: metaName, description },\n spec: { profile },\n } = props.member;\n const displayName = profile?.displayName ?? metaName;\n const entityLink = useEntityRefLink();\n\n return (\n <Card\n className={classes.card}\n href={entityLink(props.member)}\n label={t('membersListCard.cardLabel', { memberName: displayName })}\n >\n <Avatar\n className={classes.avatar}\n name={displayName}\n src={profile?.picture ?? ''}\n purpose=\"decoration\"\n size=\"x-large\"\n />\n <Flex className={classes.cardTextContainer} direction=\"column\" gap=\"1\">\n <Text variant=\"body-large\" as=\"h4\">\n {displayName}\n </Text>\n {profile?.email && (\n <Link\n className={classes.singlelineEllipsis}\n href={`mailto:${profile.email}`}\n >\n {profile.email}\n </Link>\n )}\n {description && (\n <Text className={classes.multilineEllipsis}>{description}</Text>\n )}\n </Flex>\n </Card>\n );\n};\n\n/** @public */\nexport type MembersListCardClassKey = 'memberList';\n\nconst useListStyles = makeStyles(\n () => ({\n memberList: {\n display: 'grid',\n gap: 'var(--bui-space-3)',\n gridTemplateColumns: `repeat(auto-fit, minmax(275px, 1fr))`,\n gridAutoRows: '1fr',\n margin: 0,\n padding: 0,\n paddingTop: 'var(--bui-space-3)',\n listStyle: 'none',\n },\n memberListItem: {\n display: 'contents',\n },\n }),\n { name: 'PluginOrgMembersListCardComponent' },\n);\n\n/** @public */\nexport const MembersListCard = (props: {\n memberDisplayTitle?: string;\n pageSize?: number;\n showAggregateMembersToggle?: boolean;\n relationType?: string;\n /** @deprecated Please use `relationAggregation` instead */\n relationsType?: EntityRelationAggregation;\n relationAggregation?: EntityRelationAggregation;\n}) => {\n const { t } = useTranslationRef(orgTranslationRef);\n const {\n memberDisplayTitle,\n pageSize = 50,\n showAggregateMembersToggle,\n relationType = 'memberof',\n } = props;\n const relationAggregation =\n props.relationAggregation ?? props.relationsType ?? 'direct';\n const classes = useListStyles();\n\n const { entity: groupEntity } = useEntity<GroupEntity>();\n const {\n metadata: { name: groupName, namespace: grpNamespace },\n spec: { profile },\n } = groupEntity;\n const catalogApi = useApi(catalogApiRef);\n\n const displayName = profile?.displayName ?? groupName;\n const cardTitle =\n memberDisplayTitle ??\n t('membersListCard.title', { groupName: displayName });\n\n const groupNamespace = grpNamespace || DEFAULT_NAMESPACE;\n\n const [offset, setOffset] = useState(0);\n\n const [showAggregateMembers, setShowAggregateMembers] = useState(\n relationAggregation === 'aggregated',\n );\n\n const [searchTerm, setSearchTerm] = useState('');\n\n useEffect(() => {\n setOffset(0);\n }, [searchTerm, showAggregateMembers]);\n\n const { loading: loadingDescendantMembers, value: descendantMembers } =\n useAsync(async () => {\n if (!showAggregateMembers) {\n return [] as UserEntity[];\n }\n\n return await getAllDesendantMembersForGroupEntity(\n groupEntity,\n catalogApi,\n relationType,\n );\n }, [catalogApi, groupEntity, showAggregateMembers]);\n const {\n loading,\n error,\n value: directMembers,\n } = useAsync(async () => {\n const membersList = await catalogApi.getEntities({\n filter: {\n kind: 'User',\n [`relations.${relationType.toLocaleLowerCase('en-US')}`]: [\n stringifyEntityRef({\n kind: 'group',\n namespace: groupNamespace.toLocaleLowerCase('en-US'),\n name: groupName.toLocaleLowerCase('en-US'),\n }),\n ],\n },\n });\n\n return membersList.items as UserEntity[];\n }, [catalogApi, groupEntity]);\n\n const members = removeDuplicateEntitiesFrom(\n [\n ...(directMembers ?? []),\n ...(descendantMembers && showAggregateMembers ? descendantMembers : []),\n ].sort((a, b) =>\n stringifyEntityRef(a).localeCompare(stringifyEntityRef(b)),\n ),\n ) as UserEntity[];\n\n if (loading) {\n return <Progress />;\n } else if (error) {\n return <ResponseErrorPanel error={error} />;\n }\n\n const filteredMembers = members.filter(member => {\n const fields = [\n member.metadata.name,\n member.metadata.title,\n member.spec?.profile?.displayName,\n member.spec?.profile?.email,\n ];\n return fields.some(val =>\n val\n ?.toLocaleLowerCase('en-US')\n .includes(searchTerm.toLocaleLowerCase('en-US')),\n );\n });\n\n const membersToRender = searchTerm ? filteredMembers : members;\n const totalCount = membersToRender.length;\n const hasNextPage = offset + pageSize < totalCount;\n const hasPreviousPage = offset > 0;\n\n const pagination =\n totalCount > pageSize ? (\n <TablePagination\n showPageSizeOptions={false}\n pageSizeOptions={[pageSize]}\n pageSize={pageSize}\n offset={offset}\n totalCount={totalCount}\n hasNextPage={hasNextPage}\n hasPreviousPage={hasPreviousPage}\n onNextPage={() => setOffset(prev => prev + pageSize)}\n onPreviousPage={() => setOffset(prev => Math.max(0, prev - pageSize))}\n />\n ) : undefined;\n\n let memberList: JSX.Element;\n if (membersToRender.length > 0) {\n memberList = (\n <ul className={classes.memberList}>\n {membersToRender.slice(offset, offset + pageSize).map(member => (\n <li\n className={classes.memberListItem}\n key={stringifyEntityRef(member)}\n >\n <MemberComponent member={member} />\n </li>\n ))}\n </ul>\n );\n } else {\n memberList = (\n <Box p=\"2\">\n <Text as=\"p\">\n {searchTerm\n ? t('membersListCard.noSearchResult', { searchTerm })\n : t('membersListCard.noMembersDescription')}\n </Text>\n </Box>\n );\n }\n\n return (\n <EntityInfoCard\n title={`${cardTitle} (${filteredMembers.length} of ${members.length})`}\n headerActions={\n showAggregateMembersToggle && (\n <Switch\n isSelected={showAggregateMembers}\n onChange={setShowAggregateMembers}\n label={t('membersListCard.aggregateMembersToggle.label')}\n />\n )\n }\n footerActions={pagination}\n >\n {showAggregateMembers && loadingDescendantMembers ? (\n <Progress />\n ) : (\n <>\n <SearchField\n aria-label=\"Search members\"\n placeholder=\"Search members...\"\n value={searchTerm}\n onChange={setSearchTerm}\n onClear={() => setSearchTerm('')}\n />\n {memberList}\n </>\n )}\n </EntityInfoCard>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;AAqDA,MAAM,kBAAkB,UAAA,CAAW;AAAA,EACjC,IAAA,EAAM;AAAA,IACJ,OAAA,EAAS,MAAA;AAAA,IACT,GAAA,EAAK,oBAAA;AAAA,IACL,OAAA,EAAS,oBAAA;AAAA,IACT,UAAA,EAAY,YAAA;AAAA,IACZ,aAAA,EAAe,KAAA;AAAA,IACf,MAAA,EAAQ,GAAA;AAAA,IACR,QAAA,EAAU;AAAA,GACZ;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,UAAA,EAAY;AAAA,GACd;AAAA,EACA,iBAAA,EAAmB;AAAA,IACjB,QAAA,EAAU;AAAA,GACZ;AAAA,EACA,kBAAA,EAAoB;AAAA,IAClB,QAAA,EAAU,QAAA;AAAA,IACV,YAAA,EAAc,UAAA;AAAA,IACd,UAAA,EAAY;AAAA,GACd;AAAA,EACA,iBAAA,EAAmB;AAAA,IACjB,OAAA,EAAS,aAAA;AAAA,IACT,oBAAA,EAAsB,GAAA;AAAA,IACtB,oBAAA,EAAsB,UAAA;AAAA,IACtB,QAAA,EAAU;AAAA;AAEd,CAAC,CAAA;AAED,MAAM,eAAA,GAAkB,CAAC,KAAA,KAAkC;AACzD,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,iBAAiB,CAAA;AACjD,EAAA,MAAM,UAAU,eAAA,EAAgB;AAChC,EAAA,MAAM;AAAA,IACJ,QAAA,EAAU,EAAE,IAAA,EAAM,QAAA,EAAU,WAAA,EAAY;AAAA,IACxC,IAAA,EAAM,EAAE,OAAA;AAAQ,MACd,KAAA,CAAM,MAAA;AACV,EAAA,MAAM,WAAA,GAAc,SAAS,WAAA,IAAe,QAAA;AAC5C,EAAA,MAAM,aAAa,gBAAA,EAAiB;AAEpC,EAAA,uBACE,IAAA;AAAA,IAAC,IAAA;AAAA,IAAA;AAAA,MACC,WAAW,OAAA,CAAQ,IAAA;AAAA,MACnB,IAAA,EAAM,UAAA,CAAW,KAAA,CAAM,MAAM,CAAA;AAAA,MAC7B,OAAO,CAAA,CAAE,2BAAA,EAA6B,EAAE,UAAA,EAAY,aAAa,CAAA;AAAA,MAEjE,QAAA,EAAA;AAAA,wBAAA,GAAA;AAAA,UAAC,MAAA;AAAA,UAAA;AAAA,YACC,WAAW,OAAA,CAAQ,MAAA;AAAA,YACnB,IAAA,EAAM,WAAA;AAAA,YACN,GAAA,EAAK,SAAS,OAAA,IAAW,EAAA;AAAA,YACzB,OAAA,EAAQ,YAAA;AAAA,YACR,IAAA,EAAK;AAAA;AAAA,SACP;AAAA,wBACA,IAAA,CAAC,QAAK,SAAA,EAAW,OAAA,CAAQ,mBAAmB,SAAA,EAAU,QAAA,EAAS,KAAI,GAAA,EACjE,QAAA,EAAA;AAAA,0BAAA,GAAA,CAAC,IAAA,EAAA,EAAK,OAAA,EAAQ,YAAA,EAAa,EAAA,EAAG,MAC3B,QAAA,EAAA,WAAA,EACH,CAAA;AAAA,UACC,SAAS,KAAA,oBACR,GAAA;AAAA,YAAC,IAAA;AAAA,YAAA;AAAA,cACC,WAAW,OAAA,CAAQ,kBAAA;AAAA,cACnB,IAAA,EAAM,CAAA,OAAA,EAAU,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,cAE5B,QAAA,EAAA,OAAA,CAAQ;AAAA;AAAA,WACX;AAAA,UAED,+BACC,GAAA,CAAC,IAAA,EAAA,EAAK,SAAA,EAAW,OAAA,CAAQ,mBAAoB,QAAA,EAAA,WAAA,EAAY;AAAA,SAAA,EAE7D;AAAA;AAAA;AAAA,GACF;AAEJ,CAAA;AAKA,MAAM,aAAA,GAAgB,UAAA;AAAA,EACpB,OAAO;AAAA,IACL,UAAA,EAAY;AAAA,MACV,OAAA,EAAS,MAAA;AAAA,MACT,GAAA,EAAK,oBAAA;AAAA,MACL,mBAAA,EAAqB,CAAA,oCAAA,CAAA;AAAA,MACrB,YAAA,EAAc,KAAA;AAAA,MACd,MAAA,EAAQ,CAAA;AAAA,MACR,OAAA,EAAS,CAAA;AAAA,MACT,UAAA,EAAY,oBAAA;AAAA,MACZ,SAAA,EAAW;AAAA,KACb;AAAA,IACA,cAAA,EAAgB;AAAA,MACd,OAAA,EAAS;AAAA;AACX,GACF,CAAA;AAAA,EACA,EAAE,MAAM,mCAAA;AACV,CAAA;AAGO,MAAM,eAAA,GAAkB,CAAC,KAAA,KAQ1B;AACJ,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,iBAAiB,CAAA;AACjD,EAAA,MAAM;AAAA,IACJ,kBAAA;AAAA,IACA,QAAA,GAAW,EAAA;AAAA,IACX,0BAAA;AAAA,IACA,YAAA,GAAe;AAAA,GACjB,GAAI,KAAA;AACJ,EAAA,MAAM,mBAAA,GACJ,KAAA,CAAM,mBAAA,IAAuB,KAAA,CAAM,aAAA,IAAiB,QAAA;AACtD,EAAA,MAAM,UAAU,aAAA,EAAc;AAE9B,EAAA,MAAM,EAAE,MAAA,EAAQ,WAAA,EAAY,GAAI,SAAA,EAAuB;AACvD,EAAA,MAAM;AAAA,IACJ,QAAA,EAAU,EAAE,IAAA,EAAM,SAAA,EAAW,WAAW,YAAA,EAAa;AAAA,IACrD,IAAA,EAAM,EAAE,OAAA;AAAQ,GAClB,GAAI,WAAA;AACJ,EAAA,MAAM,UAAA,GAAa,OAAO,aAAa,CAAA;AAEvC,EAAA,MAAM,WAAA,GAAc,SAAS,WAAA,IAAe,SAAA;AAC5C,EAAA,MAAM,YACJ,kBAAA,IACA,CAAA,CAAE,yBAAyB,EAAE,SAAA,EAAW,aAAa,CAAA;AAEvD,EAAA,MAAM,iBAAiB,YAAA,IAAgB,iBAAA;AAEvC,EAAA,MAAM,CAAC,MAAA,EAAQ,SAAS,CAAA,GAAI,SAAS,CAAC,CAAA;AAEtC,EAAA,MAAM,CAAC,oBAAA,EAAsB,uBAAuB,CAAA,GAAI,QAAA;AAAA,IACtD,mBAAA,KAAwB;AAAA,GAC1B;AAEA,EAAA,MAAM,CAAC,UAAA,EAAY,aAAa,CAAA,GAAI,SAAS,EAAE,CAAA;AAE/C,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,SAAA,CAAU,CAAC,CAAA;AAAA,EACb,CAAA,EAAG,CAAC,UAAA,EAAY,oBAAoB,CAAC,CAAA;AAErC,EAAA,MAAM,EAAE,OAAA,EAAS,wBAAA,EAA0B,OAAO,iBAAA,EAAkB,GAClE,SAAS,YAAY;AACnB,IAAA,IAAI,CAAC,oBAAA,EAAsB;AACzB,MAAA,OAAO,EAAC;AAAA,IACV;AAEA,IAAA,OAAO,MAAM,oCAAA;AAAA,MACX,WAAA;AAAA,MACA,UAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF,CAAA,EAAG,CAAC,UAAA,EAAY,WAAA,EAAa,oBAAoB,CAAC,CAAA;AACpD,EAAA,MAAM;AAAA,IACJ,OAAA;AAAA,IACA,KAAA;AAAA,IACA,KAAA,EAAO;AAAA,GACT,GAAI,SAAS,YAAY;AACvB,IAAA,MAAM,WAAA,GAAc,MAAM,UAAA,CAAW,WAAA,CAAY;AAAA,MAC/C,MAAA,EAAQ;AAAA,QACN,IAAA,EAAM,MAAA;AAAA,QACN,CAAC,CAAA,UAAA,EAAa,YAAA,CAAa,kBAAkB,OAAO,CAAC,EAAE,GAAG;AAAA,UACxD,kBAAA,CAAmB;AAAA,YACjB,IAAA,EAAM,OAAA;AAAA,YACN,SAAA,EAAW,cAAA,CAAe,iBAAA,CAAkB,OAAO,CAAA;AAAA,YACnD,IAAA,EAAM,SAAA,CAAU,iBAAA,CAAkB,OAAO;AAAA,WAC1C;AAAA;AACH;AACF,KACD,CAAA;AAED,IAAA,OAAO,WAAA,CAAY,KAAA;AAAA,EACrB,CAAA,EAAG,CAAC,UAAA,EAAY,WAAW,CAAC,CAAA;AAE5B,EAAA,MAAM,OAAA,GAAU,2BAAA;AAAA,IACd;AAAA,MACE,GAAI,iBAAiB,EAAC;AAAA,MACtB,GAAI,iBAAA,IAAqB,oBAAA,GAAuB,iBAAA,GAAoB;AAAC,KACvE,CAAE,IAAA;AAAA,MAAK,CAAC,GAAG,CAAA,KACT,kBAAA,CAAmB,CAAC,CAAA,CAAE,aAAA,CAAc,kBAAA,CAAmB,CAAC,CAAC;AAAA;AAC3D,GACF;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,2BAAQ,QAAA,EAAA,EAAS,CAAA;AAAA,EACnB,WAAW,KAAA,EAAO;AAChB,IAAA,uBAAO,GAAA,CAAC,sBAAmB,KAAA,EAAc,CAAA;AAAA,EAC3C;AAEA,EAAA,MAAM,eAAA,GAAkB,OAAA,CAAQ,MAAA,CAAO,CAAA,MAAA,KAAU;AAC/C,IAAA,MAAM,MAAA,GAAS;AAAA,MACb,OAAO,QAAA,CAAS,IAAA;AAAA,MAChB,OAAO,QAAA,CAAS,KAAA;AAAA,MAChB,MAAA,CAAO,MAAM,OAAA,EAAS,WAAA;AAAA,MACtB,MAAA,CAAO,MAAM,OAAA,EAAS;AAAA,KACxB;AACA,IAAA,OAAO,MAAA,CAAO,IAAA;AAAA,MAAK,CAAA,GAAA,KACjB,KACI,iBAAA,CAAkB,OAAO,EAC1B,QAAA,CAAS,UAAA,CAAW,iBAAA,CAAkB,OAAO,CAAC;AAAA,KACnD;AAAA,EACF,CAAC,CAAA;AAED,EAAA,MAAM,eAAA,GAAkB,aAAa,eAAA,GAAkB,OAAA;AACvD,EAAA,MAAM,aAAa,eAAA,CAAgB,MAAA;AACnC,EAAA,MAAM,WAAA,GAAc,SAAS,QAAA,GAAW,UAAA;AACxC,EAAA,MAAM,kBAAkB,MAAA,GAAS,CAAA;AAEjC,EAAA,MAAM,UAAA,GACJ,aAAa,QAAA,mBACX,GAAA;AAAA,IAAC,eAAA;AAAA,IAAA;AAAA,MACC,mBAAA,EAAqB,KAAA;AAAA,MACrB,eAAA,EAAiB,CAAC,QAAQ,CAAA;AAAA,MAC1B,QAAA;AAAA,MACA,MAAA;AAAA,MACA,UAAA;AAAA,MACA,WAAA;AAAA,MACA,eAAA;AAAA,MACA,UAAA,EAAY,MAAM,SAAA,CAAU,CAAA,IAAA,KAAQ,OAAO,QAAQ,CAAA;AAAA,MACnD,cAAA,EAAgB,MAAM,SAAA,CAAU,CAAA,IAAA,KAAQ,KAAK,GAAA,CAAI,CAAA,EAAG,IAAA,GAAO,QAAQ,CAAC;AAAA;AAAA,GACtE,GACE,MAAA;AAEN,EAAA,IAAI,UAAA;AACJ,EAAA,IAAI,eAAA,CAAgB,SAAS,CAAA,EAAG;AAC9B,IAAA,UAAA,mBACE,GAAA,CAAC,IAAA,EAAA,EAAG,SAAA,EAAW,OAAA,CAAQ,UAAA,EACpB,QAAA,EAAA,eAAA,CAAgB,KAAA,CAAM,MAAA,EAAQ,MAAA,GAAS,QAAQ,CAAA,CAAE,GAAA,CAAI,CAAA,MAAA,qBACpD,GAAA;AAAA,MAAC,IAAA;AAAA,MAAA;AAAA,QACC,WAAW,OAAA,CAAQ,cAAA;AAAA,QAGnB,QAAA,kBAAA,GAAA,CAAC,mBAAgB,MAAA,EAAgB;AAAA,OAAA;AAAA,MAF5B,mBAAmB,MAAM;AAAA,KAIjC,CAAA,EACH,CAAA;AAAA,EAEJ,CAAA,MAAO;AACL,IAAA,UAAA,uBACG,GAAA,EAAA,EAAI,CAAA,EAAE,KACL,QAAA,kBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,IAAG,GAAA,EACN,QAAA,EAAA,UAAA,GACG,CAAA,CAAE,gCAAA,EAAkC,EAAE,UAAA,EAAY,IAClD,CAAA,CAAE,sCAAsC,GAC9C,CAAA,EACF,CAAA;AAAA,EAEJ;AAEA,EAAA,uBACE,GAAA;AAAA,IAAC,cAAA;AAAA,IAAA;AAAA,MACC,KAAA,EAAO,GAAG,SAAS,CAAA,EAAA,EAAK,gBAAgB,MAAM,CAAA,IAAA,EAAO,QAAQ,MAAM,CAAA,CAAA,CAAA;AAAA,MACnE,eACE,0BAAA,oBACE,GAAA;AAAA,QAAC,MAAA;AAAA,QAAA;AAAA,UACC,UAAA,EAAY,oBAAA;AAAA,UACZ,QAAA,EAAU,uBAAA;AAAA,UACV,KAAA,EAAO,EAAE,8CAA8C;AAAA;AAAA,OACzD;AAAA,MAGJ,aAAA,EAAe,UAAA;AAAA,MAEd,QAAA,EAAA,oBAAA,IAAwB,wBAAA,mBACvB,GAAA,CAAC,QAAA,EAAA,EAAS,oBAEV,IAAA,CAAA,QAAA,EAAA,EACE,QAAA,EAAA;AAAA,wBAAA,GAAA;AAAA,UAAC,WAAA;AAAA,UAAA;AAAA,YACC,YAAA,EAAW,gBAAA;AAAA,YACX,WAAA,EAAY,mBAAA;AAAA,YACZ,KAAA,EAAO,UAAA;AAAA,YACP,QAAA,EAAU,aAAA;AAAA,YACV,OAAA,EAAS,MAAM,aAAA,CAAc,EAAE;AAAA;AAAA,SACjC;AAAA,QACC;AAAA,OAAA,EACH;AAAA;AAAA,GAEJ;AAEJ;;;;"}
|
|
1
|
+
{"version":3,"file":"MembersListCard.esm.js","sources":["../../../../../src/components/Cards/Group/MembersList/MembersListCard.tsx"],"sourcesContent":["/*\n * Copyright 2020 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 {\n DEFAULT_NAMESPACE,\n GroupEntity,\n UserEntity,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n catalogApiRef,\n useEntity,\n EntityInfoCard,\n useEntityRefLink,\n} from '@backstage/plugin-catalog-react';\nimport { makeStyles } from '@material-ui/core/styles';\nimport { useState, useEffect } from 'react';\nimport useAsync from 'react-use/esm/useAsync';\n\nimport { Progress, ResponseErrorPanel } from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\nimport {\n getAllDesendantMembersForGroupEntity,\n removeDuplicateEntitiesFrom,\n} from '../../../../helpers/helpers';\nimport { EntityRelationAggregation } from '../../types';\nimport { useTranslationRef } from '@backstage/frontend-plugin-api';\nimport { orgTranslationRef } from '../../../../translation';\nimport {\n Avatar,\n Box,\n Card,\n Flex,\n Link,\n SearchField,\n Switch,\n TablePagination,\n Text,\n} from '@backstage/ui';\n\nconst useMemberStyles = makeStyles({\n card: {\n display: 'flex',\n gap: 'var(--bui-space-3)',\n padding: 'var(--bui-space-3)',\n alignItems: 'flex-start',\n flexDirection: 'row',\n height: 140,\n overflow: 'hidden',\n },\n avatar: {\n flexShrink: 0,\n },\n cardTextContainer: {\n overflow: 'hidden',\n },\n singlelineEllipsis: {\n overflow: 'hidden',\n textOverflow: 'ellipsis',\n whiteSpace: 'nowrap',\n },\n multilineEllipsis: {\n display: '-webkit-box',\n '-webkit-line-clamp': '3',\n '-webkit-box-orient': 'vertical',\n overflow: 'hidden',\n },\n});\n\nconst MemberComponent = (props: { member: UserEntity }) => {\n const { t } = useTranslationRef(orgTranslationRef);\n const classes = useMemberStyles();\n const {\n metadata: { name: metaName, description },\n spec: { profile },\n } = props.member;\n const displayName = profile?.displayName ?? metaName;\n const entityLink = useEntityRefLink();\n\n return (\n <Card\n className={classes.card}\n href={entityLink(props.member)}\n label={t('membersListCard.cardLabel', { memberName: displayName })}\n >\n <Avatar\n className={classes.avatar}\n name={displayName}\n src={profile?.picture ?? ''}\n purpose=\"decoration\"\n size=\"x-large\"\n />\n <Flex className={classes.cardTextContainer} direction=\"column\" gap=\"1\">\n <Text variant=\"body-large\" as=\"h4\">\n {displayName}\n </Text>\n {profile?.email && (\n <Link\n className={classes.singlelineEllipsis}\n href={`mailto:${profile.email}`}\n >\n {profile.email}\n </Link>\n )}\n {description && (\n <Text className={classes.multilineEllipsis}>{description}</Text>\n )}\n </Flex>\n </Card>\n );\n};\n\n/** @public */\nexport type MembersListCardClassKey = 'memberList';\n\nconst useListStyles = makeStyles(\n () => ({\n memberList: {\n display: 'grid',\n gap: 'var(--bui-space-3)',\n gridTemplateColumns: `repeat(auto-fit, minmax(275px, 1fr))`,\n gridAutoRows: '1fr',\n margin: 0,\n padding: 0,\n paddingTop: 'var(--bui-space-3)',\n listStyle: 'none',\n },\n memberListItem: {\n display: 'contents',\n },\n }),\n { name: 'PluginOrgMembersListCardComponent' },\n);\n\n/** @public */\nexport const MembersListCard = (props: {\n memberDisplayTitle?: string;\n pageSize?: number;\n showAggregateMembersToggle?: boolean;\n relationType?: string;\n /** @deprecated Please use `relationAggregation` instead */\n relationsType?: EntityRelationAggregation;\n relationAggregation?: EntityRelationAggregation;\n}) => {\n const { t } = useTranslationRef(orgTranslationRef);\n const {\n memberDisplayTitle,\n pageSize = 50,\n showAggregateMembersToggle,\n relationType = 'memberof',\n } = props;\n const relationAggregation =\n props.relationAggregation ?? props.relationsType ?? 'direct';\n const classes = useListStyles();\n\n const { entity: groupEntity } = useEntity<GroupEntity>();\n const {\n metadata: { name: groupName, namespace: grpNamespace, title: groupTitle },\n spec: { profile },\n } = groupEntity;\n const catalogApi = useApi(catalogApiRef);\n\n const displayName = profile?.displayName ?? groupTitle ?? groupName;\n const cardTitle =\n memberDisplayTitle ??\n t('membersListCard.title', { groupName: displayName });\n\n const groupNamespace = grpNamespace || DEFAULT_NAMESPACE;\n\n const [offset, setOffset] = useState(0);\n\n const [showAggregateMembers, setShowAggregateMembers] = useState(\n relationAggregation === 'aggregated',\n );\n\n const [searchTerm, setSearchTerm] = useState('');\n\n useEffect(() => {\n setOffset(0);\n }, [searchTerm, showAggregateMembers]);\n\n const { loading: loadingDescendantMembers, value: descendantMembers } =\n useAsync(async () => {\n if (!showAggregateMembers) {\n return [] as UserEntity[];\n }\n\n return await getAllDesendantMembersForGroupEntity(\n groupEntity,\n catalogApi,\n relationType,\n );\n }, [catalogApi, groupEntity, showAggregateMembers]);\n const {\n loading,\n error,\n value: directMembers,\n } = useAsync(async () => {\n const membersList = await catalogApi.getEntities({\n filter: {\n kind: 'User',\n [`relations.${relationType.toLocaleLowerCase('en-US')}`]: [\n stringifyEntityRef({\n kind: 'group',\n namespace: groupNamespace.toLocaleLowerCase('en-US'),\n name: groupName.toLocaleLowerCase('en-US'),\n }),\n ],\n },\n });\n\n return membersList.items as UserEntity[];\n }, [catalogApi, groupEntity]);\n\n const members = removeDuplicateEntitiesFrom(\n [\n ...(directMembers ?? []),\n ...(descendantMembers && showAggregateMembers ? descendantMembers : []),\n ].sort((a, b) =>\n stringifyEntityRef(a).localeCompare(stringifyEntityRef(b)),\n ),\n ) as UserEntity[];\n\n if (loading) {\n return <Progress />;\n } else if (error) {\n return <ResponseErrorPanel error={error} />;\n }\n\n const filteredMembers = members.filter(member => {\n const fields = [\n member.metadata.name,\n member.metadata.title,\n member.spec?.profile?.displayName,\n member.spec?.profile?.email,\n ];\n return fields.some(val =>\n val\n ?.toLocaleLowerCase('en-US')\n .includes(searchTerm.toLocaleLowerCase('en-US')),\n );\n });\n\n const membersToRender = searchTerm ? filteredMembers : members;\n const totalCount = membersToRender.length;\n const hasNextPage = offset + pageSize < totalCount;\n const hasPreviousPage = offset > 0;\n\n const pagination =\n totalCount > pageSize ? (\n <TablePagination\n showPageSizeOptions={false}\n pageSizeOptions={[pageSize]}\n pageSize={pageSize}\n offset={offset}\n totalCount={totalCount}\n hasNextPage={hasNextPage}\n hasPreviousPage={hasPreviousPage}\n onNextPage={() => setOffset(prev => prev + pageSize)}\n onPreviousPage={() => setOffset(prev => Math.max(0, prev - pageSize))}\n />\n ) : undefined;\n\n let memberList: JSX.Element;\n if (membersToRender.length > 0) {\n memberList = (\n <ul className={classes.memberList}>\n {membersToRender.slice(offset, offset + pageSize).map(member => (\n <li\n className={classes.memberListItem}\n key={stringifyEntityRef(member)}\n >\n <MemberComponent member={member} />\n </li>\n ))}\n </ul>\n );\n } else {\n memberList = (\n <Box p=\"2\">\n <Text as=\"p\">\n {searchTerm\n ? t('membersListCard.noSearchResult', { searchTerm })\n : t('membersListCard.noMembersDescription')}\n </Text>\n </Box>\n );\n }\n\n return (\n <EntityInfoCard\n title={`${cardTitle} (${filteredMembers.length} of ${members.length})`}\n headerActions={\n showAggregateMembersToggle && (\n <Switch\n isSelected={showAggregateMembers}\n onChange={setShowAggregateMembers}\n label={t('membersListCard.aggregateMembersToggle.label')}\n />\n )\n }\n footerActions={pagination}\n >\n {showAggregateMembers && loadingDescendantMembers ? (\n <Progress />\n ) : (\n <>\n <SearchField\n aria-label=\"Search members\"\n placeholder=\"Search members...\"\n value={searchTerm}\n onChange={setSearchTerm}\n onClear={() => setSearchTerm('')}\n />\n {memberList}\n </>\n )}\n </EntityInfoCard>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;AAqDA,MAAM,kBAAkB,UAAA,CAAW;AAAA,EACjC,IAAA,EAAM;AAAA,IACJ,OAAA,EAAS,MAAA;AAAA,IACT,GAAA,EAAK,oBAAA;AAAA,IACL,OAAA,EAAS,oBAAA;AAAA,IACT,UAAA,EAAY,YAAA;AAAA,IACZ,aAAA,EAAe,KAAA;AAAA,IACf,MAAA,EAAQ,GAAA;AAAA,IACR,QAAA,EAAU;AAAA,GACZ;AAAA,EACA,MAAA,EAAQ;AAAA,IACN,UAAA,EAAY;AAAA,GACd;AAAA,EACA,iBAAA,EAAmB;AAAA,IACjB,QAAA,EAAU;AAAA,GACZ;AAAA,EACA,kBAAA,EAAoB;AAAA,IAClB,QAAA,EAAU,QAAA;AAAA,IACV,YAAA,EAAc,UAAA;AAAA,IACd,UAAA,EAAY;AAAA,GACd;AAAA,EACA,iBAAA,EAAmB;AAAA,IACjB,OAAA,EAAS,aAAA;AAAA,IACT,oBAAA,EAAsB,GAAA;AAAA,IACtB,oBAAA,EAAsB,UAAA;AAAA,IACtB,QAAA,EAAU;AAAA;AAEd,CAAC,CAAA;AAED,MAAM,eAAA,GAAkB,CAAC,KAAA,KAAkC;AACzD,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,iBAAiB,CAAA;AACjD,EAAA,MAAM,UAAU,eAAA,EAAgB;AAChC,EAAA,MAAM;AAAA,IACJ,QAAA,EAAU,EAAE,IAAA,EAAM,QAAA,EAAU,WAAA,EAAY;AAAA,IACxC,IAAA,EAAM,EAAE,OAAA;AAAQ,MACd,KAAA,CAAM,MAAA;AACV,EAAA,MAAM,WAAA,GAAc,SAAS,WAAA,IAAe,QAAA;AAC5C,EAAA,MAAM,aAAa,gBAAA,EAAiB;AAEpC,EAAA,uBACE,IAAA;AAAA,IAAC,IAAA;AAAA,IAAA;AAAA,MACC,WAAW,OAAA,CAAQ,IAAA;AAAA,MACnB,IAAA,EAAM,UAAA,CAAW,KAAA,CAAM,MAAM,CAAA;AAAA,MAC7B,OAAO,CAAA,CAAE,2BAAA,EAA6B,EAAE,UAAA,EAAY,aAAa,CAAA;AAAA,MAEjE,QAAA,EAAA;AAAA,wBAAA,GAAA;AAAA,UAAC,MAAA;AAAA,UAAA;AAAA,YACC,WAAW,OAAA,CAAQ,MAAA;AAAA,YACnB,IAAA,EAAM,WAAA;AAAA,YACN,GAAA,EAAK,SAAS,OAAA,IAAW,EAAA;AAAA,YACzB,OAAA,EAAQ,YAAA;AAAA,YACR,IAAA,EAAK;AAAA;AAAA,SACP;AAAA,wBACA,IAAA,CAAC,QAAK,SAAA,EAAW,OAAA,CAAQ,mBAAmB,SAAA,EAAU,QAAA,EAAS,KAAI,GAAA,EACjE,QAAA,EAAA;AAAA,0BAAA,GAAA,CAAC,IAAA,EAAA,EAAK,OAAA,EAAQ,YAAA,EAAa,EAAA,EAAG,MAC3B,QAAA,EAAA,WAAA,EACH,CAAA;AAAA,UACC,SAAS,KAAA,oBACR,GAAA;AAAA,YAAC,IAAA;AAAA,YAAA;AAAA,cACC,WAAW,OAAA,CAAQ,kBAAA;AAAA,cACnB,IAAA,EAAM,CAAA,OAAA,EAAU,OAAA,CAAQ,KAAK,CAAA,CAAA;AAAA,cAE5B,QAAA,EAAA,OAAA,CAAQ;AAAA;AAAA,WACX;AAAA,UAED,+BACC,GAAA,CAAC,IAAA,EAAA,EAAK,SAAA,EAAW,OAAA,CAAQ,mBAAoB,QAAA,EAAA,WAAA,EAAY;AAAA,SAAA,EAE7D;AAAA;AAAA;AAAA,GACF;AAEJ,CAAA;AAKA,MAAM,aAAA,GAAgB,UAAA;AAAA,EACpB,OAAO;AAAA,IACL,UAAA,EAAY;AAAA,MACV,OAAA,EAAS,MAAA;AAAA,MACT,GAAA,EAAK,oBAAA;AAAA,MACL,mBAAA,EAAqB,CAAA,oCAAA,CAAA;AAAA,MACrB,YAAA,EAAc,KAAA;AAAA,MACd,MAAA,EAAQ,CAAA;AAAA,MACR,OAAA,EAAS,CAAA;AAAA,MACT,UAAA,EAAY,oBAAA;AAAA,MACZ,SAAA,EAAW;AAAA,KACb;AAAA,IACA,cAAA,EAAgB;AAAA,MACd,OAAA,EAAS;AAAA;AACX,GACF,CAAA;AAAA,EACA,EAAE,MAAM,mCAAA;AACV,CAAA;AAGO,MAAM,eAAA,GAAkB,CAAC,KAAA,KAQ1B;AACJ,EAAA,MAAM,EAAE,CAAA,EAAE,GAAI,iBAAA,CAAkB,iBAAiB,CAAA;AACjD,EAAA,MAAM;AAAA,IACJ,kBAAA;AAAA,IACA,QAAA,GAAW,EAAA;AAAA,IACX,0BAAA;AAAA,IACA,YAAA,GAAe;AAAA,GACjB,GAAI,KAAA;AACJ,EAAA,MAAM,mBAAA,GACJ,KAAA,CAAM,mBAAA,IAAuB,KAAA,CAAM,aAAA,IAAiB,QAAA;AACtD,EAAA,MAAM,UAAU,aAAA,EAAc;AAE9B,EAAA,MAAM,EAAE,MAAA,EAAQ,WAAA,EAAY,GAAI,SAAA,EAAuB;AACvD,EAAA,MAAM;AAAA,IACJ,UAAU,EAAE,IAAA,EAAM,WAAW,SAAA,EAAW,YAAA,EAAc,OAAO,UAAA,EAAW;AAAA,IACxE,IAAA,EAAM,EAAE,OAAA;AAAQ,GAClB,GAAI,WAAA;AACJ,EAAA,MAAM,UAAA,GAAa,OAAO,aAAa,CAAA;AAEvC,EAAA,MAAM,WAAA,GAAc,OAAA,EAAS,WAAA,IAAe,UAAA,IAAc,SAAA;AAC1D,EAAA,MAAM,YACJ,kBAAA,IACA,CAAA,CAAE,yBAAyB,EAAE,SAAA,EAAW,aAAa,CAAA;AAEvD,EAAA,MAAM,iBAAiB,YAAA,IAAgB,iBAAA;AAEvC,EAAA,MAAM,CAAC,MAAA,EAAQ,SAAS,CAAA,GAAI,SAAS,CAAC,CAAA;AAEtC,EAAA,MAAM,CAAC,oBAAA,EAAsB,uBAAuB,CAAA,GAAI,QAAA;AAAA,IACtD,mBAAA,KAAwB;AAAA,GAC1B;AAEA,EAAA,MAAM,CAAC,UAAA,EAAY,aAAa,CAAA,GAAI,SAAS,EAAE,CAAA;AAE/C,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,SAAA,CAAU,CAAC,CAAA;AAAA,EACb,CAAA,EAAG,CAAC,UAAA,EAAY,oBAAoB,CAAC,CAAA;AAErC,EAAA,MAAM,EAAE,OAAA,EAAS,wBAAA,EAA0B,OAAO,iBAAA,EAAkB,GAClE,SAAS,YAAY;AACnB,IAAA,IAAI,CAAC,oBAAA,EAAsB;AACzB,MAAA,OAAO,EAAC;AAAA,IACV;AAEA,IAAA,OAAO,MAAM,oCAAA;AAAA,MACX,WAAA;AAAA,MACA,UAAA;AAAA,MACA;AAAA,KACF;AAAA,EACF,CAAA,EAAG,CAAC,UAAA,EAAY,WAAA,EAAa,oBAAoB,CAAC,CAAA;AACpD,EAAA,MAAM;AAAA,IACJ,OAAA;AAAA,IACA,KAAA;AAAA,IACA,KAAA,EAAO;AAAA,GACT,GAAI,SAAS,YAAY;AACvB,IAAA,MAAM,WAAA,GAAc,MAAM,UAAA,CAAW,WAAA,CAAY;AAAA,MAC/C,MAAA,EAAQ;AAAA,QACN,IAAA,EAAM,MAAA;AAAA,QACN,CAAC,CAAA,UAAA,EAAa,YAAA,CAAa,kBAAkB,OAAO,CAAC,EAAE,GAAG;AAAA,UACxD,kBAAA,CAAmB;AAAA,YACjB,IAAA,EAAM,OAAA;AAAA,YACN,SAAA,EAAW,cAAA,CAAe,iBAAA,CAAkB,OAAO,CAAA;AAAA,YACnD,IAAA,EAAM,SAAA,CAAU,iBAAA,CAAkB,OAAO;AAAA,WAC1C;AAAA;AACH;AACF,KACD,CAAA;AAED,IAAA,OAAO,WAAA,CAAY,KAAA;AAAA,EACrB,CAAA,EAAG,CAAC,UAAA,EAAY,WAAW,CAAC,CAAA;AAE5B,EAAA,MAAM,OAAA,GAAU,2BAAA;AAAA,IACd;AAAA,MACE,GAAI,iBAAiB,EAAC;AAAA,MACtB,GAAI,iBAAA,IAAqB,oBAAA,GAAuB,iBAAA,GAAoB;AAAC,KACvE,CAAE,IAAA;AAAA,MAAK,CAAC,GAAG,CAAA,KACT,kBAAA,CAAmB,CAAC,CAAA,CAAE,aAAA,CAAc,kBAAA,CAAmB,CAAC,CAAC;AAAA;AAC3D,GACF;AAEA,EAAA,IAAI,OAAA,EAAS;AACX,IAAA,2BAAQ,QAAA,EAAA,EAAS,CAAA;AAAA,EACnB,WAAW,KAAA,EAAO;AAChB,IAAA,uBAAO,GAAA,CAAC,sBAAmB,KAAA,EAAc,CAAA;AAAA,EAC3C;AAEA,EAAA,MAAM,eAAA,GAAkB,OAAA,CAAQ,MAAA,CAAO,CAAA,MAAA,KAAU;AAC/C,IAAA,MAAM,MAAA,GAAS;AAAA,MACb,OAAO,QAAA,CAAS,IAAA;AAAA,MAChB,OAAO,QAAA,CAAS,KAAA;AAAA,MAChB,MAAA,CAAO,MAAM,OAAA,EAAS,WAAA;AAAA,MACtB,MAAA,CAAO,MAAM,OAAA,EAAS;AAAA,KACxB;AACA,IAAA,OAAO,MAAA,CAAO,IAAA;AAAA,MAAK,CAAA,GAAA,KACjB,KACI,iBAAA,CAAkB,OAAO,EAC1B,QAAA,CAAS,UAAA,CAAW,iBAAA,CAAkB,OAAO,CAAC;AAAA,KACnD;AAAA,EACF,CAAC,CAAA;AAED,EAAA,MAAM,eAAA,GAAkB,aAAa,eAAA,GAAkB,OAAA;AACvD,EAAA,MAAM,aAAa,eAAA,CAAgB,MAAA;AACnC,EAAA,MAAM,WAAA,GAAc,SAAS,QAAA,GAAW,UAAA;AACxC,EAAA,MAAM,kBAAkB,MAAA,GAAS,CAAA;AAEjC,EAAA,MAAM,UAAA,GACJ,aAAa,QAAA,mBACX,GAAA;AAAA,IAAC,eAAA;AAAA,IAAA;AAAA,MACC,mBAAA,EAAqB,KAAA;AAAA,MACrB,eAAA,EAAiB,CAAC,QAAQ,CAAA;AAAA,MAC1B,QAAA;AAAA,MACA,MAAA;AAAA,MACA,UAAA;AAAA,MACA,WAAA;AAAA,MACA,eAAA;AAAA,MACA,UAAA,EAAY,MAAM,SAAA,CAAU,CAAA,IAAA,KAAQ,OAAO,QAAQ,CAAA;AAAA,MACnD,cAAA,EAAgB,MAAM,SAAA,CAAU,CAAA,IAAA,KAAQ,KAAK,GAAA,CAAI,CAAA,EAAG,IAAA,GAAO,QAAQ,CAAC;AAAA;AAAA,GACtE,GACE,MAAA;AAEN,EAAA,IAAI,UAAA;AACJ,EAAA,IAAI,eAAA,CAAgB,SAAS,CAAA,EAAG;AAC9B,IAAA,UAAA,mBACE,GAAA,CAAC,IAAA,EAAA,EAAG,SAAA,EAAW,OAAA,CAAQ,UAAA,EACpB,QAAA,EAAA,eAAA,CAAgB,KAAA,CAAM,MAAA,EAAQ,MAAA,GAAS,QAAQ,CAAA,CAAE,GAAA,CAAI,CAAA,MAAA,qBACpD,GAAA;AAAA,MAAC,IAAA;AAAA,MAAA;AAAA,QACC,WAAW,OAAA,CAAQ,cAAA;AAAA,QAGnB,QAAA,kBAAA,GAAA,CAAC,mBAAgB,MAAA,EAAgB;AAAA,OAAA;AAAA,MAF5B,mBAAmB,MAAM;AAAA,KAIjC,CAAA,EACH,CAAA;AAAA,EAEJ,CAAA,MAAO;AACL,IAAA,UAAA,uBACG,GAAA,EAAA,EAAI,CAAA,EAAE,KACL,QAAA,kBAAA,GAAA,CAAC,IAAA,EAAA,EAAK,IAAG,GAAA,EACN,QAAA,EAAA,UAAA,GACG,CAAA,CAAE,gCAAA,EAAkC,EAAE,UAAA,EAAY,IAClD,CAAA,CAAE,sCAAsC,GAC9C,CAAA,EACF,CAAA;AAAA,EAEJ;AAEA,EAAA,uBACE,GAAA;AAAA,IAAC,cAAA;AAAA,IAAA;AAAA,MACC,KAAA,EAAO,GAAG,SAAS,CAAA,EAAA,EAAK,gBAAgB,MAAM,CAAA,IAAA,EAAO,QAAQ,MAAM,CAAA,CAAA,CAAA;AAAA,MACnE,eACE,0BAAA,oBACE,GAAA;AAAA,QAAC,MAAA;AAAA,QAAA;AAAA,UACC,UAAA,EAAY,oBAAA;AAAA,UACZ,QAAA,EAAU,uBAAA;AAAA,UACV,KAAA,EAAO,EAAE,8CAA8C;AAAA;AAAA,OACzD;AAAA,MAGJ,aAAA,EAAe,UAAA;AAAA,MAEd,QAAA,EAAA,oBAAA,IAAwB,wBAAA,mBACvB,GAAA,CAAC,QAAA,EAAA,EAAS,oBAEV,IAAA,CAAA,QAAA,EAAA,EACE,QAAA,EAAA;AAAA,wBAAA,GAAA;AAAA,UAAC,WAAA;AAAA,UAAA;AAAA,YACC,YAAA,EAAW,gBAAA;AAAA,YACX,WAAA,EAAY,mBAAA;AAAA,YACZ,KAAA,EAAO,UAAA;AAAA,YACP,QAAA,EAAU,aAAA;AAAA,YACV,OAAA,EAAS,MAAM,aAAA,CAAc,EAAE;AAAA;AAAA,SACjC;AAAA,QACC;AAAA,OAAA,EACH;AAAA;AAAA,GAEJ;AAEJ;;;;"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { stringifyEntityRef,
|
|
2
|
-
import { catalogApiRef,
|
|
1
|
+
import { stringifyEntityRef, RELATION_PARENT_OF, RELATION_MEMBER_OF } from '@backstage/catalog-model';
|
|
2
|
+
import { catalogApiRef, entityPresentationSnapshot, getEntityRelations } from '@backstage/plugin-catalog-react';
|
|
3
3
|
import limiterFactory from 'p-limit';
|
|
4
4
|
import { useApi } from '@backstage/core-plugin-api';
|
|
5
5
|
import useAsync from 'react-use/esm/useAsync';
|
|
@@ -10,7 +10,7 @@ const limiter = limiterFactory(5);
|
|
|
10
10
|
const getQueryParams = (ownersEntityRef, selectedEntity) => {
|
|
11
11
|
const { kind, type } = selectedEntity;
|
|
12
12
|
const owners = ownersEntityRef.map(
|
|
13
|
-
(
|
|
13
|
+
(ref) => entityPresentationSnapshot(ref, { defaultKind: "group" }).primaryTitle
|
|
14
14
|
);
|
|
15
15
|
const filters = {
|
|
16
16
|
kind: kind.toLocaleLowerCase("en-US"),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useGetEntities.esm.js","sources":["../../../../src/components/Cards/OwnershipCard/useGetEntities.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n Entity,\n parseEntityRef,\n RELATION_MEMBER_OF,\n RELATION_PARENT_OF,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n CatalogApi,\n catalogApiRef,\n getEntityRelations,\n humanizeEntityRef,\n} from '@backstage/plugin-catalog-react';\nimport limiterFactory from 'p-limit';\nimport { useApi } from '@backstage/core-plugin-api';\nimport useAsync from 'react-use/esm/useAsync';\nimport qs from 'qs';\nimport { EntityRelationAggregation } from '../types';\nimport { uniq, uniqBy } from 'lodash';\n\nconst limiter = limiterFactory(5);\n\ntype EntityTypeProps = {\n kind: string;\n type?: string;\n count: number;\n};\n\nconst getQueryParams = (\n ownersEntityRef: string[],\n selectedEntity: EntityTypeProps,\n): string => {\n const { kind, type } = selectedEntity;\n const owners = ownersEntityRef.map(owner =>\n humanizeEntityRef(parseEntityRef(owner), { defaultKind: 'group' }),\n );\n const filters = {\n kind: kind.toLocaleLowerCase('en-US'),\n type,\n owners,\n user: 'all',\n };\n return qs.stringify({ filters }, { arrayFormat: 'repeat' });\n};\n\nconst getMemberOfEntityRefs = (owner: Entity): string[] => {\n const parentGroups = getEntityRelations(owner, RELATION_MEMBER_OF, {\n kind: 'Group',\n });\n\n const ownerGroupsNames = parentGroups.map(({ kind, namespace, name }) =>\n stringifyEntityRef({\n kind,\n namespace,\n name,\n }),\n );\n\n return [...ownerGroupsNames, stringifyEntityRef(owner)];\n};\n\nconst isEntity = (entity: Entity | undefined): entity is Entity =>\n entity !== undefined;\n\nconst getChildOwnershipEntityRefs = async (\n entity: Entity,\n catalogApi: CatalogApi,\n alreadyRetrievedParentRefs: string[] = [],\n): Promise<string[]> => {\n const childGroups = getEntityRelations(entity, RELATION_PARENT_OF, {\n kind: 'Group',\n });\n\n const hasChildGroups = childGroups.length > 0;\n\n const entityRef = stringifyEntityRef(entity);\n if (hasChildGroups) {\n const entityRefs = childGroups.map(r => stringifyEntityRef(r));\n const childGroupResponse = await limiter(() =>\n catalogApi.getEntitiesByRefs({\n fields: ['kind', 'metadata.namespace', 'metadata.name', 'relations'],\n entityRefs,\n }),\n );\n const childGroupEntities = childGroupResponse.items.filter(isEntity);\n\n const unknownChildren = childGroupEntities.filter(\n childGroupEntity =>\n !alreadyRetrievedParentRefs.includes(\n stringifyEntityRef(childGroupEntity),\n ),\n );\n const childrenRefs = (\n await Promise.all(\n unknownChildren.map(childGroupEntity =>\n getChildOwnershipEntityRefs(childGroupEntity, catalogApi, [\n ...alreadyRetrievedParentRefs,\n entityRef,\n ]),\n ),\n )\n ).flatMap(aggregated => aggregated);\n\n return uniq([...childrenRefs, entityRef]);\n }\n\n return [entityRef];\n};\n\nconst getOwners = async (\n entity: Entity,\n relationAggregation: EntityRelationAggregation,\n catalogApi: CatalogApi,\n): Promise<string[]> => {\n const isGroup = entity.kind === 'Group';\n const isAggregated = relationAggregation === 'aggregated';\n const isUserEntity = entity.kind === 'User';\n\n if (isAggregated && isGroup) {\n return getChildOwnershipEntityRefs(entity, catalogApi);\n }\n\n if (isAggregated && isUserEntity) {\n return getMemberOfEntityRefs(entity);\n }\n\n return [stringifyEntityRef(entity)];\n};\n\nconst delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));\n\nconst batchGetOwnedEntitiesByOwners = async (\n owners: string[],\n kinds: string[],\n catalogApi: CatalogApi,\n batchSize: number = 100,\n delayMs: number = 100,\n) => {\n const results = [];\n\n for (let i = 0; i < owners.length; i += batchSize) {\n const batch = owners.slice(i, i + batchSize);\n const response = await catalogApi.getEntities({\n filter: [\n {\n kind: kinds,\n 'relations.ownedBy': batch,\n },\n ],\n fields: [\n 'kind',\n 'metadata.name',\n 'metadata.namespace',\n 'spec.type',\n 'relations',\n ],\n });\n\n results.push(...response.items);\n\n if (i + batchSize < owners.length) await delay(delayMs);\n }\n\n return uniqBy(results, stringifyEntityRef);\n};\n\nexport function useGetEntities(\n entity: Entity,\n relationAggregation: EntityRelationAggregation,\n entityFilterKind?: string[],\n entityLimit = 6,\n): {\n componentsWithCounters:\n | {\n counter: number;\n type: string;\n kind: string;\n queryParams: string;\n }[]\n | undefined;\n loading: boolean;\n error?: Error;\n} {\n const catalogApi = useApi(catalogApiRef);\n const kinds = entityFilterKind ?? ['Component', 'API', 'System', 'Resource'];\n\n const {\n loading,\n error,\n value: componentsWithCounters,\n } = useAsync(async () => {\n const owners = await getOwners(entity, relationAggregation, catalogApi);\n\n const ownedEntitiesList = await batchGetOwnedEntitiesByOwners(\n owners,\n kinds,\n catalogApi,\n );\n\n const counts = ownedEntitiesList.reduce(\n (acc: EntityTypeProps[], ownedEntity) => {\n const match = acc.find(\n x => x.kind === ownedEntity.kind && x.type === ownedEntity.spec?.type,\n );\n if (match) {\n match.count += 1;\n } else {\n acc.push({\n kind: ownedEntity.kind,\n type: ownedEntity.spec?.type?.toString(),\n count: 1,\n });\n }\n return acc;\n },\n [],\n );\n\n // Return top N (entityLimit) entities to be displayed in ownership boxes\n const topN = counts.sort((a, b) => b.count - a.count).slice(0, entityLimit);\n\n return topN.map(topOwnedEntity => ({\n counter: topOwnedEntity.count,\n type: topOwnedEntity.type,\n kind: topOwnedEntity.kind,\n queryParams: getQueryParams(owners, topOwnedEntity),\n })) as Array<{\n counter: number;\n type: string;\n kind: string;\n queryParams: string;\n }>;\n }, [catalogApi, entity, relationAggregation]);\n\n return {\n componentsWithCounters,\n loading,\n error,\n };\n}\n"],"names":[],"mappings":";;;;;;;;AAoCA,MAAM,OAAA,GAAU,eAAe,CAAC,CAAA;AAQhC,MAAM,cAAA,GAAiB,CACrB,eAAA,EACA,cAAA,KACW;AACX,EAAA,MAAM,EAAE,IAAA,EAAM,IAAA,EAAK,GAAI,cAAA;AACvB,EAAA,MAAM,SAAS,eAAA,CAAgB,GAAA;AAAA,IAAI,CAAA,KAAA,KACjC,kBAAkB,cAAA,CAAe,KAAK,GAAG,EAAE,WAAA,EAAa,SAAS;AAAA,GACnE;AACA,EAAA,MAAM,OAAA,GAAU;AAAA,IACd,IAAA,EAAM,IAAA,CAAK,iBAAA,CAAkB,OAAO,CAAA;AAAA,IACpC,IAAA;AAAA,IACA,MAAA;AAAA,IACA,IAAA,EAAM;AAAA,GACR;AACA,EAAA,OAAO,EAAA,CAAG,UAAU,EAAE,OAAA,IAAW,EAAE,WAAA,EAAa,UAAU,CAAA;AAC5D,CAAA;AAEA,MAAM,qBAAA,GAAwB,CAAC,KAAA,KAA4B;AACzD,EAAA,MAAM,YAAA,GAAe,kBAAA,CAAmB,KAAA,EAAO,kBAAA,EAAoB;AAAA,IACjE,IAAA,EAAM;AAAA,GACP,CAAA;AAED,EAAA,MAAM,mBAAmB,YAAA,CAAa,GAAA;AAAA,IAAI,CAAC,EAAE,IAAA,EAAM,SAAA,EAAW,IAAA,OAC5D,kBAAA,CAAmB;AAAA,MACjB,IAAA;AAAA,MACA,SAAA;AAAA,MACA;AAAA,KACD;AAAA,GACH;AAEA,EAAA,OAAO,CAAC,GAAG,gBAAA,EAAkB,kBAAA,CAAmB,KAAK,CAAC,CAAA;AACxD,CAAA;AAEA,MAAM,QAAA,GAAW,CAAC,MAAA,KAChB,MAAA,KAAW,MAAA;AAEb,MAAM,8BAA8B,OAClC,MAAA,EACA,UAAA,EACA,0BAAA,GAAuC,EAAC,KAClB;AACtB,EAAA,MAAM,WAAA,GAAc,kBAAA,CAAmB,MAAA,EAAQ,kBAAA,EAAoB;AAAA,IACjE,IAAA,EAAM;AAAA,GACP,CAAA;AAED,EAAA,MAAM,cAAA,GAAiB,YAAY,MAAA,GAAS,CAAA;AAE5C,EAAA,MAAM,SAAA,GAAY,mBAAmB,MAAM,CAAA;AAC3C,EAAA,IAAI,cAAA,EAAgB;AAClB,IAAA,MAAM,aAAa,WAAA,CAAY,GAAA,CAAI,CAAA,CAAA,KAAK,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAC7D,IAAA,MAAM,qBAAqB,MAAM,OAAA;AAAA,MAAQ,MACvC,WAAW,iBAAA,CAAkB;AAAA,QAC3B,MAAA,EAAQ,CAAC,MAAA,EAAQ,oBAAA,EAAsB,iBAAiB,WAAW,CAAA;AAAA,QACnE;AAAA,OACD;AAAA,KACH;AACA,IAAA,MAAM,kBAAA,GAAqB,kBAAA,CAAmB,KAAA,CAAM,MAAA,CAAO,QAAQ,CAAA;AAEnE,IAAA,MAAM,kBAAkB,kBAAA,CAAmB,MAAA;AAAA,MACzC,CAAA,gBAAA,KACE,CAAC,0BAAA,CAA2B,QAAA;AAAA,QAC1B,mBAAmB,gBAAgB;AAAA;AACrC,KACJ;AACA,IAAA,MAAM,YAAA,GAAA,CACJ,MAAM,OAAA,CAAQ,GAAA;AAAA,MACZ,eAAA,CAAgB,GAAA;AAAA,QAAI,CAAA,gBAAA,KAClB,2BAAA,CAA4B,gBAAA,EAAkB,UAAA,EAAY;AAAA,UACxD,GAAG,0BAAA;AAAA,UACH;AAAA,SACD;AAAA;AACH,KACF,EACA,OAAA,CAAQ,CAAA,UAAA,KAAc,UAAU,CAAA;AAElC,IAAA,OAAO,IAAA,CAAK,CAAC,GAAG,YAAA,EAAc,SAAS,CAAC,CAAA;AAAA,EAC1C;AAEA,EAAA,OAAO,CAAC,SAAS,CAAA;AACnB,CAAA;AAEA,MAAM,SAAA,GAAY,OAChB,MAAA,EACA,mBAAA,EACA,UAAA,KACsB;AACtB,EAAA,MAAM,OAAA,GAAU,OAAO,IAAA,KAAS,OAAA;AAChC,EAAA,MAAM,eAAe,mBAAA,KAAwB,YAAA;AAC7C,EAAA,MAAM,YAAA,GAAe,OAAO,IAAA,KAAS,MAAA;AAErC,EAAA,IAAI,gBAAgB,OAAA,EAAS;AAC3B,IAAA,OAAO,2BAAA,CAA4B,QAAQ,UAAU,CAAA;AAAA,EACvD;AAEA,EAAA,IAAI,gBAAgB,YAAA,EAAc;AAChC,IAAA,OAAO,sBAAsB,MAAM,CAAA;AAAA,EACrC;AAEA,EAAA,OAAO,CAAC,kBAAA,CAAmB,MAAM,CAAC,CAAA;AACpC,CAAA;AAEA,MAAM,KAAA,GAAQ,CAAC,EAAA,KAAe,IAAI,QAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,EAAE,CAAC,CAAA;AAE5E,MAAM,6BAAA,GAAgC,OACpC,MAAA,EACA,KAAA,EACA,YACA,SAAA,GAAoB,GAAA,EACpB,UAAkB,GAAA,KACf;AACH,EAAA,MAAM,UAAU,EAAC;AAEjB,EAAA,KAAA,IAAS,IAAI,CAAA,EAAG,CAAA,GAAI,MAAA,CAAO,MAAA,EAAQ,KAAK,SAAA,EAAW;AACjD,IAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,IAAI,SAAS,CAAA;AAC3C,IAAA,MAAM,QAAA,GAAW,MAAM,UAAA,CAAW,WAAA,CAAY;AAAA,MAC5C,MAAA,EAAQ;AAAA,QACN;AAAA,UACE,IAAA,EAAM,KAAA;AAAA,UACN,mBAAA,EAAqB;AAAA;AACvB,OACF;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,MAAA;AAAA,QACA,eAAA;AAAA,QACA,oBAAA;AAAA,QACA,WAAA;AAAA,QACA;AAAA;AACF,KACD,CAAA;AAED,IAAA,OAAA,CAAQ,IAAA,CAAK,GAAG,QAAA,CAAS,KAAK,CAAA;AAE9B,IAAA,IAAI,IAAI,SAAA,GAAY,MAAA,CAAO,MAAA,EAAQ,MAAM,MAAM,OAAO,CAAA;AAAA,EACxD;AAEA,EAAA,OAAO,MAAA,CAAO,SAAS,kBAAkB,CAAA;AAC3C,CAAA;AAEO,SAAS,cAAA,CACd,MAAA,EACA,mBAAA,EACA,gBAAA,EACA,cAAc,CAAA,EAYd;AACA,EAAA,MAAM,UAAA,GAAa,OAAO,aAAa,CAAA;AACvC,EAAA,MAAM,QAAQ,gBAAA,IAAoB,CAAC,WAAA,EAAa,KAAA,EAAO,UAAU,UAAU,CAAA;AAE3E,EAAA,MAAM;AAAA,IACJ,OAAA;AAAA,IACA,KAAA;AAAA,IACA,KAAA,EAAO;AAAA,GACT,GAAI,SAAS,YAAY;AACvB,IAAA,MAAM,MAAA,GAAS,MAAM,SAAA,CAAU,MAAA,EAAQ,qBAAqB,UAAU,CAAA;AAEtE,IAAA,MAAM,oBAAoB,MAAM,6BAAA;AAAA,MAC9B,MAAA;AAAA,MACA,KAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,MAAM,SAAS,iBAAA,CAAkB,MAAA;AAAA,MAC/B,CAAC,KAAwB,WAAA,KAAgB;AACvC,QAAA,MAAM,QAAQ,GAAA,CAAI,IAAA;AAAA,UAChB,CAAA,CAAA,KAAK,EAAE,IAAA,KAAS,WAAA,CAAY,QAAQ,CAAA,CAAE,IAAA,KAAS,YAAY,IAAA,EAAM;AAAA,SACnE;AACA,QAAA,IAAI,KAAA,EAAO;AACT,UAAA,KAAA,CAAM,KAAA,IAAS,CAAA;AAAA,QACjB,CAAA,MAAO;AACL,UAAA,GAAA,CAAI,IAAA,CAAK;AAAA,YACP,MAAM,WAAA,CAAY,IAAA;AAAA,YAClB,IAAA,EAAM,WAAA,CAAY,IAAA,EAAM,IAAA,EAAM,QAAA,EAAS;AAAA,YACvC,KAAA,EAAO;AAAA,WACR,CAAA;AAAA,QACH;AACA,QAAA,OAAO,GAAA;AAAA,MACT,CAAA;AAAA,MACA;AAAC,KACH;AAGA,IAAA,MAAM,IAAA,GAAO,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,CAAA,CAAE,KAAA,GAAQ,CAAA,CAAE,KAAK,CAAA,CAAE,KAAA,CAAM,GAAG,WAAW,CAAA;AAE1E,IAAA,OAAO,IAAA,CAAK,IAAI,CAAA,cAAA,MAAmB;AAAA,MACjC,SAAS,cAAA,CAAe,KAAA;AAAA,MACxB,MAAM,cAAA,CAAe,IAAA;AAAA,MACrB,MAAM,cAAA,CAAe,IAAA;AAAA,MACrB,WAAA,EAAa,cAAA,CAAe,MAAA,EAAQ,cAAc;AAAA,KACpD,CAAE,CAAA;AAAA,EAMJ,CAAA,EAAG,CAAC,UAAA,EAAY,MAAA,EAAQ,mBAAmB,CAAC,CAAA;AAE5C,EAAA,OAAO;AAAA,IACL,sBAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACF;AACF;;;;"}
|
|
1
|
+
{"version":3,"file":"useGetEntities.esm.js","sources":["../../../../src/components/Cards/OwnershipCard/useGetEntities.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n Entity,\n RELATION_MEMBER_OF,\n RELATION_PARENT_OF,\n stringifyEntityRef,\n} from '@backstage/catalog-model';\nimport {\n CatalogApi,\n catalogApiRef,\n entityPresentationSnapshot,\n getEntityRelations,\n} from '@backstage/plugin-catalog-react';\nimport limiterFactory from 'p-limit';\nimport { useApi } from '@backstage/core-plugin-api';\nimport useAsync from 'react-use/esm/useAsync';\nimport qs from 'qs';\nimport { EntityRelationAggregation } from '../types';\nimport { uniq, uniqBy } from 'lodash';\n\nconst limiter = limiterFactory(5);\n\ntype EntityTypeProps = {\n kind: string;\n type?: string;\n count: number;\n};\n\nconst getQueryParams = (\n ownersEntityRef: string[],\n selectedEntity: EntityTypeProps,\n): string => {\n const { kind, type } = selectedEntity;\n const owners = ownersEntityRef.map(\n ref =>\n entityPresentationSnapshot(ref, { defaultKind: 'group' }).primaryTitle,\n );\n const filters = {\n kind: kind.toLocaleLowerCase('en-US'),\n type,\n owners,\n user: 'all',\n };\n return qs.stringify({ filters }, { arrayFormat: 'repeat' });\n};\n\nconst getMemberOfEntityRefs = (owner: Entity): string[] => {\n const parentGroups = getEntityRelations(owner, RELATION_MEMBER_OF, {\n kind: 'Group',\n });\n\n const ownerGroupsNames = parentGroups.map(({ kind, namespace, name }) =>\n stringifyEntityRef({\n kind,\n namespace,\n name,\n }),\n );\n\n return [...ownerGroupsNames, stringifyEntityRef(owner)];\n};\n\nconst isEntity = (entity: Entity | undefined): entity is Entity =>\n entity !== undefined;\n\nconst getChildOwnershipEntityRefs = async (\n entity: Entity,\n catalogApi: CatalogApi,\n alreadyRetrievedParentRefs: string[] = [],\n): Promise<string[]> => {\n const childGroups = getEntityRelations(entity, RELATION_PARENT_OF, {\n kind: 'Group',\n });\n\n const hasChildGroups = childGroups.length > 0;\n\n const entityRef = stringifyEntityRef(entity);\n if (hasChildGroups) {\n const entityRefs = childGroups.map(r => stringifyEntityRef(r));\n const childGroupResponse = await limiter(() =>\n catalogApi.getEntitiesByRefs({\n fields: ['kind', 'metadata.namespace', 'metadata.name', 'relations'],\n entityRefs,\n }),\n );\n const childGroupEntities = childGroupResponse.items.filter(isEntity);\n\n const unknownChildren = childGroupEntities.filter(\n childGroupEntity =>\n !alreadyRetrievedParentRefs.includes(\n stringifyEntityRef(childGroupEntity),\n ),\n );\n const childrenRefs = (\n await Promise.all(\n unknownChildren.map(childGroupEntity =>\n getChildOwnershipEntityRefs(childGroupEntity, catalogApi, [\n ...alreadyRetrievedParentRefs,\n entityRef,\n ]),\n ),\n )\n ).flatMap(aggregated => aggregated);\n\n return uniq([...childrenRefs, entityRef]);\n }\n\n return [entityRef];\n};\n\nconst getOwners = async (\n entity: Entity,\n relationAggregation: EntityRelationAggregation,\n catalogApi: CatalogApi,\n): Promise<string[]> => {\n const isGroup = entity.kind === 'Group';\n const isAggregated = relationAggregation === 'aggregated';\n const isUserEntity = entity.kind === 'User';\n\n if (isAggregated && isGroup) {\n return getChildOwnershipEntityRefs(entity, catalogApi);\n }\n\n if (isAggregated && isUserEntity) {\n return getMemberOfEntityRefs(entity);\n }\n\n return [stringifyEntityRef(entity)];\n};\n\nconst delay = (ms: number) => new Promise(resolve => setTimeout(resolve, ms));\n\nconst batchGetOwnedEntitiesByOwners = async (\n owners: string[],\n kinds: string[],\n catalogApi: CatalogApi,\n batchSize: number = 100,\n delayMs: number = 100,\n) => {\n const results = [];\n\n for (let i = 0; i < owners.length; i += batchSize) {\n const batch = owners.slice(i, i + batchSize);\n const response = await catalogApi.getEntities({\n filter: [\n {\n kind: kinds,\n 'relations.ownedBy': batch,\n },\n ],\n fields: [\n 'kind',\n 'metadata.name',\n 'metadata.namespace',\n 'spec.type',\n 'relations',\n ],\n });\n\n results.push(...response.items);\n\n if (i + batchSize < owners.length) await delay(delayMs);\n }\n\n return uniqBy(results, stringifyEntityRef);\n};\n\nexport function useGetEntities(\n entity: Entity,\n relationAggregation: EntityRelationAggregation,\n entityFilterKind?: string[],\n entityLimit = 6,\n): {\n componentsWithCounters:\n | {\n counter: number;\n type: string;\n kind: string;\n queryParams: string;\n }[]\n | undefined;\n loading: boolean;\n error?: Error;\n} {\n const catalogApi = useApi(catalogApiRef);\n const kinds = entityFilterKind ?? ['Component', 'API', 'System', 'Resource'];\n\n const {\n loading,\n error,\n value: componentsWithCounters,\n } = useAsync(async () => {\n const owners = await getOwners(entity, relationAggregation, catalogApi);\n\n const ownedEntitiesList = await batchGetOwnedEntitiesByOwners(\n owners,\n kinds,\n catalogApi,\n );\n\n const counts = ownedEntitiesList.reduce(\n (acc: EntityTypeProps[], ownedEntity) => {\n const match = acc.find(\n x => x.kind === ownedEntity.kind && x.type === ownedEntity.spec?.type,\n );\n if (match) {\n match.count += 1;\n } else {\n acc.push({\n kind: ownedEntity.kind,\n type: ownedEntity.spec?.type?.toString(),\n count: 1,\n });\n }\n return acc;\n },\n [],\n );\n\n // Return top N (entityLimit) entities to be displayed in ownership boxes\n const topN = counts.sort((a, b) => b.count - a.count).slice(0, entityLimit);\n\n return topN.map(topOwnedEntity => ({\n counter: topOwnedEntity.count,\n type: topOwnedEntity.type,\n kind: topOwnedEntity.kind,\n queryParams: getQueryParams(owners, topOwnedEntity),\n })) as Array<{\n counter: number;\n type: string;\n kind: string;\n queryParams: string;\n }>;\n }, [catalogApi, entity, relationAggregation]);\n\n return {\n componentsWithCounters,\n loading,\n error,\n };\n}\n"],"names":[],"mappings":";;;;;;;;AAmCA,MAAM,OAAA,GAAU,eAAe,CAAC,CAAA;AAQhC,MAAM,cAAA,GAAiB,CACrB,eAAA,EACA,cAAA,KACW;AACX,EAAA,MAAM,EAAE,IAAA,EAAM,IAAA,EAAK,GAAI,cAAA;AACvB,EAAA,MAAM,SAAS,eAAA,CAAgB,GAAA;AAAA,IAC7B,SACE,0BAAA,CAA2B,GAAA,EAAK,EAAE,WAAA,EAAa,OAAA,EAAS,CAAA,CAAE;AAAA,GAC9D;AACA,EAAA,MAAM,OAAA,GAAU;AAAA,IACd,IAAA,EAAM,IAAA,CAAK,iBAAA,CAAkB,OAAO,CAAA;AAAA,IACpC,IAAA;AAAA,IACA,MAAA;AAAA,IACA,IAAA,EAAM;AAAA,GACR;AACA,EAAA,OAAO,EAAA,CAAG,UAAU,EAAE,OAAA,IAAW,EAAE,WAAA,EAAa,UAAU,CAAA;AAC5D,CAAA;AAEA,MAAM,qBAAA,GAAwB,CAAC,KAAA,KAA4B;AACzD,EAAA,MAAM,YAAA,GAAe,kBAAA,CAAmB,KAAA,EAAO,kBAAA,EAAoB;AAAA,IACjE,IAAA,EAAM;AAAA,GACP,CAAA;AAED,EAAA,MAAM,mBAAmB,YAAA,CAAa,GAAA;AAAA,IAAI,CAAC,EAAE,IAAA,EAAM,SAAA,EAAW,IAAA,OAC5D,kBAAA,CAAmB;AAAA,MACjB,IAAA;AAAA,MACA,SAAA;AAAA,MACA;AAAA,KACD;AAAA,GACH;AAEA,EAAA,OAAO,CAAC,GAAG,gBAAA,EAAkB,kBAAA,CAAmB,KAAK,CAAC,CAAA;AACxD,CAAA;AAEA,MAAM,QAAA,GAAW,CAAC,MAAA,KAChB,MAAA,KAAW,MAAA;AAEb,MAAM,8BAA8B,OAClC,MAAA,EACA,UAAA,EACA,0BAAA,GAAuC,EAAC,KAClB;AACtB,EAAA,MAAM,WAAA,GAAc,kBAAA,CAAmB,MAAA,EAAQ,kBAAA,EAAoB;AAAA,IACjE,IAAA,EAAM;AAAA,GACP,CAAA;AAED,EAAA,MAAM,cAAA,GAAiB,YAAY,MAAA,GAAS,CAAA;AAE5C,EAAA,MAAM,SAAA,GAAY,mBAAmB,MAAM,CAAA;AAC3C,EAAA,IAAI,cAAA,EAAgB;AAClB,IAAA,MAAM,aAAa,WAAA,CAAY,GAAA,CAAI,CAAA,CAAA,KAAK,kBAAA,CAAmB,CAAC,CAAC,CAAA;AAC7D,IAAA,MAAM,qBAAqB,MAAM,OAAA;AAAA,MAAQ,MACvC,WAAW,iBAAA,CAAkB;AAAA,QAC3B,MAAA,EAAQ,CAAC,MAAA,EAAQ,oBAAA,EAAsB,iBAAiB,WAAW,CAAA;AAAA,QACnE;AAAA,OACD;AAAA,KACH;AACA,IAAA,MAAM,kBAAA,GAAqB,kBAAA,CAAmB,KAAA,CAAM,MAAA,CAAO,QAAQ,CAAA;AAEnE,IAAA,MAAM,kBAAkB,kBAAA,CAAmB,MAAA;AAAA,MACzC,CAAA,gBAAA,KACE,CAAC,0BAAA,CAA2B,QAAA;AAAA,QAC1B,mBAAmB,gBAAgB;AAAA;AACrC,KACJ;AACA,IAAA,MAAM,YAAA,GAAA,CACJ,MAAM,OAAA,CAAQ,GAAA;AAAA,MACZ,eAAA,CAAgB,GAAA;AAAA,QAAI,CAAA,gBAAA,KAClB,2BAAA,CAA4B,gBAAA,EAAkB,UAAA,EAAY;AAAA,UACxD,GAAG,0BAAA;AAAA,UACH;AAAA,SACD;AAAA;AACH,KACF,EACA,OAAA,CAAQ,CAAA,UAAA,KAAc,UAAU,CAAA;AAElC,IAAA,OAAO,IAAA,CAAK,CAAC,GAAG,YAAA,EAAc,SAAS,CAAC,CAAA;AAAA,EAC1C;AAEA,EAAA,OAAO,CAAC,SAAS,CAAA;AACnB,CAAA;AAEA,MAAM,SAAA,GAAY,OAChB,MAAA,EACA,mBAAA,EACA,UAAA,KACsB;AACtB,EAAA,MAAM,OAAA,GAAU,OAAO,IAAA,KAAS,OAAA;AAChC,EAAA,MAAM,eAAe,mBAAA,KAAwB,YAAA;AAC7C,EAAA,MAAM,YAAA,GAAe,OAAO,IAAA,KAAS,MAAA;AAErC,EAAA,IAAI,gBAAgB,OAAA,EAAS;AAC3B,IAAA,OAAO,2BAAA,CAA4B,QAAQ,UAAU,CAAA;AAAA,EACvD;AAEA,EAAA,IAAI,gBAAgB,YAAA,EAAc;AAChC,IAAA,OAAO,sBAAsB,MAAM,CAAA;AAAA,EACrC;AAEA,EAAA,OAAO,CAAC,kBAAA,CAAmB,MAAM,CAAC,CAAA;AACpC,CAAA;AAEA,MAAM,KAAA,GAAQ,CAAC,EAAA,KAAe,IAAI,QAAQ,CAAA,OAAA,KAAW,UAAA,CAAW,OAAA,EAAS,EAAE,CAAC,CAAA;AAE5E,MAAM,6BAAA,GAAgC,OACpC,MAAA,EACA,KAAA,EACA,YACA,SAAA,GAAoB,GAAA,EACpB,UAAkB,GAAA,KACf;AACH,EAAA,MAAM,UAAU,EAAC;AAEjB,EAAA,KAAA,IAAS,IAAI,CAAA,EAAG,CAAA,GAAI,MAAA,CAAO,MAAA,EAAQ,KAAK,SAAA,EAAW;AACjD,IAAA,MAAM,KAAA,GAAQ,MAAA,CAAO,KAAA,CAAM,CAAA,EAAG,IAAI,SAAS,CAAA;AAC3C,IAAA,MAAM,QAAA,GAAW,MAAM,UAAA,CAAW,WAAA,CAAY;AAAA,MAC5C,MAAA,EAAQ;AAAA,QACN;AAAA,UACE,IAAA,EAAM,KAAA;AAAA,UACN,mBAAA,EAAqB;AAAA;AACvB,OACF;AAAA,MACA,MAAA,EAAQ;AAAA,QACN,MAAA;AAAA,QACA,eAAA;AAAA,QACA,oBAAA;AAAA,QACA,WAAA;AAAA,QACA;AAAA;AACF,KACD,CAAA;AAED,IAAA,OAAA,CAAQ,IAAA,CAAK,GAAG,QAAA,CAAS,KAAK,CAAA;AAE9B,IAAA,IAAI,IAAI,SAAA,GAAY,MAAA,CAAO,MAAA,EAAQ,MAAM,MAAM,OAAO,CAAA;AAAA,EACxD;AAEA,EAAA,OAAO,MAAA,CAAO,SAAS,kBAAkB,CAAA;AAC3C,CAAA;AAEO,SAAS,cAAA,CACd,MAAA,EACA,mBAAA,EACA,gBAAA,EACA,cAAc,CAAA,EAYd;AACA,EAAA,MAAM,UAAA,GAAa,OAAO,aAAa,CAAA;AACvC,EAAA,MAAM,QAAQ,gBAAA,IAAoB,CAAC,WAAA,EAAa,KAAA,EAAO,UAAU,UAAU,CAAA;AAE3E,EAAA,MAAM;AAAA,IACJ,OAAA;AAAA,IACA,KAAA;AAAA,IACA,KAAA,EAAO;AAAA,GACT,GAAI,SAAS,YAAY;AACvB,IAAA,MAAM,MAAA,GAAS,MAAM,SAAA,CAAU,MAAA,EAAQ,qBAAqB,UAAU,CAAA;AAEtE,IAAA,MAAM,oBAAoB,MAAM,6BAAA;AAAA,MAC9B,MAAA;AAAA,MACA,KAAA;AAAA,MACA;AAAA,KACF;AAEA,IAAA,MAAM,SAAS,iBAAA,CAAkB,MAAA;AAAA,MAC/B,CAAC,KAAwB,WAAA,KAAgB;AACvC,QAAA,MAAM,QAAQ,GAAA,CAAI,IAAA;AAAA,UAChB,CAAA,CAAA,KAAK,EAAE,IAAA,KAAS,WAAA,CAAY,QAAQ,CAAA,CAAE,IAAA,KAAS,YAAY,IAAA,EAAM;AAAA,SACnE;AACA,QAAA,IAAI,KAAA,EAAO;AACT,UAAA,KAAA,CAAM,KAAA,IAAS,CAAA;AAAA,QACjB,CAAA,MAAO;AACL,UAAA,GAAA,CAAI,IAAA,CAAK;AAAA,YACP,MAAM,WAAA,CAAY,IAAA;AAAA,YAClB,IAAA,EAAM,WAAA,CAAY,IAAA,EAAM,IAAA,EAAM,QAAA,EAAS;AAAA,YACvC,KAAA,EAAO;AAAA,WACR,CAAA;AAAA,QACH;AACA,QAAA,OAAO,GAAA;AAAA,MACT,CAAA;AAAA,MACA;AAAC,KACH;AAGA,IAAA,MAAM,IAAA,GAAO,MAAA,CAAO,IAAA,CAAK,CAAC,CAAA,EAAG,CAAA,KAAM,CAAA,CAAE,KAAA,GAAQ,CAAA,CAAE,KAAK,CAAA,CAAE,KAAA,CAAM,GAAG,WAAW,CAAA;AAE1E,IAAA,OAAO,IAAA,CAAK,IAAI,CAAA,cAAA,MAAmB;AAAA,MACjC,SAAS,cAAA,CAAe,KAAA;AAAA,MACxB,MAAM,cAAA,CAAe,IAAA;AAAA,MACrB,MAAM,cAAA,CAAe,IAAA;AAAA,MACrB,WAAA,EAAa,cAAA,CAAe,MAAA,EAAQ,cAAc;AAAA,KACpD,CAAE,CAAA;AAAA,EAMJ,CAAA,EAAG,CAAC,UAAA,EAAY,MAAA,EAAQ,mBAAmB,CAAC,CAAA;AAE5C,EAAA,OAAO;AAAA,IACL,sBAAA;AAAA,IACA,OAAA;AAAA,IACA;AAAA,GACF;AACF;;;;"}
|
package/dist/package.json.esm.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-org",
|
|
3
|
-
"version": "0.7.1
|
|
3
|
+
"version": "0.7.1",
|
|
4
4
|
"description": "A Backstage plugin that helps you create entity pages for your organization",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -63,13 +63,13 @@
|
|
|
63
63
|
"test": "backstage-cli package test"
|
|
64
64
|
},
|
|
65
65
|
"dependencies": {
|
|
66
|
-
"@backstage/catalog-model": "1.
|
|
67
|
-
"@backstage/core-components": "0.18.9
|
|
68
|
-
"@backstage/core-plugin-api": "1.12.5
|
|
69
|
-
"@backstage/frontend-plugin-api": "0.16.0
|
|
70
|
-
"@backstage/plugin-catalog-common": "1.1.9
|
|
71
|
-
"@backstage/plugin-catalog-react": "2.1.2
|
|
72
|
-
"@backstage/ui": "0.14.0
|
|
66
|
+
"@backstage/catalog-model": "^1.8.0",
|
|
67
|
+
"@backstage/core-components": "^0.18.9",
|
|
68
|
+
"@backstage/core-plugin-api": "^1.12.5",
|
|
69
|
+
"@backstage/frontend-plugin-api": "^0.16.0",
|
|
70
|
+
"@backstage/plugin-catalog-common": "^1.1.9",
|
|
71
|
+
"@backstage/plugin-catalog-react": "^2.1.2",
|
|
72
|
+
"@backstage/ui": "^0.14.0",
|
|
73
73
|
"@material-ui/core": "^4.12.2",
|
|
74
74
|
"@material-ui/icons": "^4.9.1",
|
|
75
75
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
@@ -81,16 +81,16 @@
|
|
|
81
81
|
"react-use": "^17.2.4"
|
|
82
82
|
},
|
|
83
83
|
"devDependencies": {
|
|
84
|
-
"@backstage/catalog-client": "1.
|
|
85
|
-
"@backstage/cli": "0.36.1
|
|
86
|
-
"@backstage/core-app-api": "1.20.0
|
|
87
|
-
"@backstage/dev-utils": "1.1.22
|
|
88
|
-
"@backstage/frontend-test-utils": "0.5.2
|
|
89
|
-
"@backstage/plugin-catalog": "2.0.2
|
|
90
|
-
"@backstage/plugin-permission-common": "0.9.8
|
|
91
|
-
"@backstage/plugin-permission-react": "0.
|
|
92
|
-
"@backstage/test-utils": "1.7.17
|
|
93
|
-
"@backstage/types": "1.2.2",
|
|
84
|
+
"@backstage/catalog-client": "^1.15.0",
|
|
85
|
+
"@backstage/cli": "^0.36.1",
|
|
86
|
+
"@backstage/core-app-api": "^1.20.0",
|
|
87
|
+
"@backstage/dev-utils": "^1.1.22",
|
|
88
|
+
"@backstage/frontend-test-utils": "^0.5.2",
|
|
89
|
+
"@backstage/plugin-catalog": "^2.0.2",
|
|
90
|
+
"@backstage/plugin-permission-common": "^0.9.8",
|
|
91
|
+
"@backstage/plugin-permission-react": "^0.5.0",
|
|
92
|
+
"@backstage/test-utils": "^1.7.17",
|
|
93
|
+
"@backstage/types": "^1.2.2",
|
|
94
94
|
"@testing-library/dom": "^10.0.0",
|
|
95
95
|
"@testing-library/jest-dom": "^6.0.0",
|
|
96
96
|
"@testing-library/react": "^16.0.0",
|