feat(clerk-js): Use org:sys_domains:read for improved fine grain control of the UI
#1896
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| '@clerk/clerk-js': patch | ||
| '@clerk/types': patch | ||
| --- | ||
|
|
||
| Shows list of domains if member has the `org:sys_domain:read` permission. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| --- | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,11 @@ | ||
| import type { GetDomainsParams, OrganizationDomainResource, OrganizationEnrollmentMode } from '@clerk/types'; | ||
| import type { OrganizationDomainVerificationStatus } from '@clerk/types'; | ||
| import React, { useMemo } from 'react'; | ||
|
|
||
| import { stripOrigin, toURL, trimLeadingSlash } from '../../../utils'; | ||
| import { useGate, withGate } from '../../common'; | ||
| import { useCoreOrganization } from '../../contexts'; | ||
| import type { LocalizationKey } from '../../customizables'; | ||
| import { Box, Col, localizationKeys, Spinner } from '../../customizables'; | ||
| import { ArrowBlockButton, BlockWithTrailingComponent, ThreeDotsMenu } from '../../elements'; | ||
| import { useInView } from '../../hooks'; | ||
|
|
@@ -17,10 +19,61 @@ type DomainListProps = GetDomainsParams & { | |
| * Enables internal links to navigate to the correct page | ||
| * based on when this component is used | ||
| */ | ||
| redirectSubPath: 'organization-settings/domain' | 'domain'; | ||
| fallback?: React.ReactNode; | ||
| }; | ||
|
|
||
| const useDomainList = () => { | ||
| const { isAuthorizedUser: canDeleteDomain } = useGate({ permission: 'org:sys_domains:delete' }); | ||
| const { isAuthorizedUser: canVerifyDomain } = useGate({ permission: 'org:sys_domains:manage' }); | ||
|
|
||
| return { | ||
| showDotMenu: canDeleteDomain || canVerifyDomain, | ||
| canVerifyDomain, | ||
| canDeleteDomain, | ||
| }; | ||
| }; | ||
|
|
||
| const buildDomainListRelativeURL = (parentPath: string, domainId: string, mode?: 'verify' | 'remove') => | ||
| trimLeadingSlash(stripOrigin(toURL(`${parentPath}/${domainId}/${mode || ''}`))); | ||
|
|
||
| const useMenuActions = ( | ||
| parentPath: string, | ||
| domainId: string, | ||
| ): { label: LocalizationKey; onClick: () => Promise<unknown>; isDestructive?: boolean }[] => { | ||
| const { canDeleteDomain, canVerifyDomain } = useDomainList(); | ||
| const { navigate } = useRouter(); | ||
|
|
||
| const menuActions = []; | ||
|
|
||
| if (canVerifyDomain) { | ||
| menuActions.push({ | ||
| label: localizationKeys('organizationProfile.profilePage.domainSection.unverifiedDomain_menuAction__verify'), | ||
| onClick: () => navigate(buildDomainListRelativeURL(parentPath, domainId, 'verify')), | ||
| }); | ||
| } | ||
|
|
||
| if (canDeleteDomain) { | ||
| menuActions.push({ | ||
| label: localizationKeys('organizationProfile.profilePage.domainSection.unverifiedDomain_menuAction__remove'), | ||
| isDestructive: true, | ||
| onClick: () => navigate(buildDomainListRelativeURL(parentPath, domainId, 'remove')), | ||
| }); | ||
| } | ||
|
|
||
| return menuActions; | ||
| }; | ||
|
|
||
| const DomainListDotMenu = ({ | ||
| redirectSubPath, | ||
| domainId, | ||
| }: Pick<DomainListProps, 'redirectSubPath'> & { | ||
| domainId: OrganizationDomainResource['id']; | ||
| }) => { | ||
| const actions = useMenuActions(redirectSubPath, domainId); | ||
| return <ThreeDotsMenu actions={actions} />; | ||
| }; | ||
|
|
||
| export const DomainList = withGate( | ||
| (props: DomainListProps) => { | ||
| const { verificationStatus, enrollmentMode, redirectSubPath, fallback, ...rest } = props; | ||
|
|
@@ -31,6 +84,7 @@ export const DomainList = withGate( | |
| }, | ||
| }); | ||
|
|
||
| const { showDotMenu } = useDomainList(); | ||
| const { ref } = useInView({ | ||
| threshold: 0, | ||
| onChange: inView => { | ||
|
|
@@ -69,7 +123,7 @@ export const DomainList = withGate( | |
| <Col> | ||
| {domainList.length === 0 && !domains?.isLoading && fallback} | ||
| {domainList.map(d => { | ||
| if (!(d.verification && d.verification.status === 'verified') || !showDotMenu) { | ||
| return ( | ||
| <BlockWithTrailingComponent | ||
| key={d.id} | ||
|
|
@@ -82,23 +136,12 @@ export const DomainList = withGate( | |
| })} | ||
| badge={<EnrollmentBadge organizationDomain={d} />} | ||
| trailingComponent={ | ||
| showDotMenu ? ( | ||
|
Contributor
There was a problem hiding this comment. 🙃
Contributor
Author
There was a problem hiding this comment. Already tried that, seems like
Contributor
There was a problem hiding this comment. Why don't we update its types?
Contributor
Author
There was a problem hiding this comment. The following has type of showDotMenu && (
<DomainListDotMenu
redirectSubPath={redirectSubPath}
domainId={d.id}
/>
)
So i would have to do (showDotMenu || null ) && (
<DomainListDotMenu
redirectSubPath={redirectSubPath}
domainId={d.id}
/>
)Which i'm not convinced it is better
Contributor
There was a problem hiding this comment. I am not sure I understand what you are talking about. Is this the type?
Contributor
Author
There was a problem hiding this comment. This is the TS error |
||
| <DomainListDotMenu | ||
| redirectSubPath={redirectSubPath} | ||
| domainId={d.id} | ||
| /> | ||
| ) : undefined | ||
| } | ||
| > | ||
| {d.name} | ||
|
|
@@ -116,7 +159,7 @@ export const DomainList = withGate( | |
| padding: `${t.space.$3} ${t.space.$4}`, | ||
| minHeight: t.sizes.$10, | ||
| })} | ||
| onClick={() => navigate(buildDomainListRelativeURL(redirectSubPath, d.id))} | ||
| > | ||
| {d.name} | ||
| </ArrowBlockButton> | ||
|
|
@@ -154,6 +197,6 @@ export const DomainList = withGate( | |
| ); | ||
| }, | ||
| { | ||
| permission: 'org:sys_domains:read', | ||
| }, | ||
| ); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.