Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/ripe-ways-greet.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/localizations': minor
'@clerk/clerk-js': minor
'@clerk/shared': minor
'@clerk/ui': minor
---

Handle expired organization domains on self-serve SSO flow, allowing to trigger a new verification
5 changes: 5 additions & 0 deletions packages/localizations/src/en-US.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -649,8 +649,12 @@ export const enUS: LocalizationResource = {
},
organizationDomainsStep: {
domainCard: {
badge__expired: 'Expired',
badge__unverified: 'Unverified',
badge__verified: 'Verified',
expiredAtLabel:
"Domain verification expired on {{ date | shortDate('en-US') }}. Verify again to generate a new DNS record.",
expiredLabel: 'Domain verification expired. Verify again to generate a new DNS record.',
removeButtonTooltip__lastVerifiedDomain: 'At least one verified domain is required to set up SSO.',
removeButtonTooltip__lastVerifiedDomainActive: 'At least one verified domain is required to keep SSO enabled.',
txtRecord: {
Expand All@@ -660,6 +664,7 @@ export const enUS: LocalizationResource = {
valueLabel: 'Value',
},
verifiedAtLabel: "Verified on {{ date | shortDate('en-US') }}",
verifyAgainButton: 'Verify again',
},
domainSuggestion: {
formButtonPrimary__add: 'Add {{domain}}',
Expand Down
5 changes: 1 addition & 4 deletions packages/shared/src/react/hooks/useOrganizationDomains.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -137,10 +137,7 @@ function useOrganizationDomains(params: UseOrganizationDomainsParams = {}): UseO
const unverifiedOwnershipDomainIds = useMemo(
() =>
(response?.data ?? [])
.filter(
(domain: OrganizationDomainResource) =>
domain.ownershipVerification && domain.ownershipVerification.status !== 'verified',
)
.filter((domain: OrganizationDomainResource) => domain.ownershipVerification?.status === 'unverified')
.map((domain: OrganizationDomainResource) => domain.id),
[response?.data],
);
Expand Down
3 changes: 2 additions & 1 deletion packages/shared/src/types/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type { EmailAddressIdentifier, UsernameIdentifier } from './identifiers';
import type { ActClaim } from './jwtv2';
import type { OAuthProvider } from './oauth';
import type {
OrganizationDomainOwnershipVerificationStatus,
OrganizationDomainOwnershipVerificationStrategy,
OrganizationDomainVerificationStatus,
OrganizationEnrollmentMode,
Expand DownExpand Up@@ -436,7 +437,7 @@ export interface OrganizationDomainVerificationJSON {
}

export interface OrganizationDomainOwnershipVerificationJSON {
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
strategy: OrganizationDomainOwnershipVerificationStrategy;
attempts: number | null;
expire_at: number | null;
Expand Down
4 changes: 4 additions & 0 deletions packages/shared/src/types/localization.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1390,7 +1390,11 @@ export type __internal_LocalizationResource = {
domainCard: {
badge__verified: LocalizationValue;
badge__unverified: LocalizationValue;
badge__expired: LocalizationValue;
verifiedAtLabel: LocalizationValue<'date'>;
expiredAtLabel: LocalizationValue<'date'>;
expiredLabel: LocalizationValue;
verifyAgainButton: LocalizationValue;
removeButtonTooltip__lastVerifiedDomain: LocalizationValue;
removeButtonTooltip__lastVerifiedDomainActive: LocalizationValue;
txtRecord: {
Expand Down
31 changes: 26 additions & 5 deletions packages/shared/src/types/organizationDomain.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,30 +34,51 @@ type OrganizationDomainVerificationStrategy = 'email_code';
/**
* The current status of an Organization domain verification.
*
* <ul>
* <li>`unverified`: Verification has not been completed yet. An attempt may be pending.</li>
* <li>`verified`: Verification has been completed.</li>
* <li>`failed`: Too many verification attempts were made without success.</li>
* <li>`expired`: The pending verification attempt expired before it could be completed.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified' | 'failed' | 'expired';

/**
* The current status of an Organization domain ownership verification.
*
* <ul>
* <li>`unverified`: Ownership has not been established yet. A TXT challenge is pending.</li>
* <li>`verified`: Ownership has been verified.</li>
* <li>`expired`: The pending ownership verification attempt expired before ownership could be confirmed. A new TXT challenge must be issued (via `prepareOwnershipVerification()`) to retry.</li>
* </ul>
*
* @inline
*/
export type OrganizationDomainVerificationStatus = 'unverified' | 'verified';
export type OrganizationDomainOwnershipVerificationStatus = 'unverified' | 'verified' | 'expired';

/**
* The strategy used to verify ownership of an Organization's domain.
* @inline
*/
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override';
export type OrganizationDomainOwnershipVerificationStrategy = 'txt' | 'legacy' | 'manual_override' | 'parent_domain';

/**
* Holds the ownership verification details of an Organization's [Verified Domain](https://clerk.com/docs/guides/organizations/add-members/verified-domains). Ownership proves control of the underlying DNS domain, typically by publishing a TXT record, and is required before the domain can be used for enterprise SSO.
*/
export interface OrganizationDomainOwnershipVerification {
/**
* The current status of the domain ownership verification.
* The current status of the domain ownership verification. A status of `expired` means the pending TXT challenge expired before ownership could be confirmed and a new challenge must be issued.
*/
status: OrganizationDomainVerificationStatus;
status: OrganizationDomainOwnershipVerificationStatus;
/**
* The strategy used to verify ownership of the domain.
* <ul>
* <li>`txt`: Ownership is proven by publishing a DNS TXT record (see `txtRecordName` and `txtRecordValue` on `OrganizationDomainOwnershipVerification`).</li>
* <li>`legacy`: Ownership was implicitly granted to domains that predate the TXT verification flow, so no per-attempt proof exists.</li>
* <li>`manual_override`: Ownership was granted manually by a Clerk admin via the Backend API or Dashboard, bypassing the DNS challenge.</li>
* <li>`parent_domain`: Ownership was inherited from a parent domain that has already been verified, so no per-attempt proof exists.</li>
* </ul>
*/
strategy: OrganizationDomainOwnershipVerificationStrategy;
Expand All@@ -66,7 +87,7 @@ export interface OrganizationDomainOwnershipVerification {
*/
attempts: number | null;
/**
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt.
* The date and time when the current ownership verification attempt expires, or `null` when there is no pending attempt. When `status` is `expired`, this is the date and time at which the attempt expired.
*/
expiresAt: Date | null;
/**
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ import { useCardState } from '@/elements/contexts';
import { Field } from '@/elements/FieldControl';
import { Form } from '@/elements/Form';
import { Tooltip } from '@/elements/Tooltip';
import { Checkmark, Clipboard, Close } from '@/icons';
import { Checkmark, Clipboard, Close, RotateLeftRight } from '@/icons';
import { common } from '@/styledSystem';
import { useFormControl } from '@/ui/utils/useFormControl';
import { getFieldError, getGlobalError } from '@/utils/errorHandler';
Expand All@@ -43,7 +43,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
organizationDomains,
organizationEnterpriseConnection,
contentRef,
organizationDomainMutations: { createDomain, revalidate },
organizationDomainMutations: { createDomain, revalidate, prepareOwnershipVerification },
enterpriseConnectionMutations: { updateConnection },
} = useConfigureSSO();
const { goPrev, goNext, isFirstStep, isLastStep } = useWizard();
Expand DownExpand Up@@ -81,6 +81,17 @@ export const OrganizationDomainsStep = (): JSX.Element => {
}
};

const handlePrepareOwnershipVerification = async (domain: OrganizationDomainResource) => {
card.setError(undefined);

try {
await prepareOwnershipVerification([domain]);
} catch (err: any) {
const apiError = getFieldError(err) ?? getGlobalError(err);
card.setError(apiError);
}
};

const handleRemoveDomain = async (domain: OrganizationDomainResource) => {
if (enterpriseConnection) {
const domains = enterpriseConnection.domains.filter(name => name !== domain.name);
Expand DownExpand Up@@ -158,6 +169,7 @@ export const OrganizationDomainsStep = (): JSX.Element => {
key={domain.id}
domain={domain}
onRemove={() => setDomainToRemove(domain)}
onPrepareOwnershipVerification={() => handlePrepareOwnershipVerification(domain)}
isRemoveDisabled={isRemoveDisabled}
removeDisabledTooltip={lastVerifiedDomainTooltip}
/>
Expand DownExpand Up@@ -353,11 +365,13 @@ const DomainSuggestion = ({ onSubmit }: { onSubmit: (domain: string) => Promise<
const DomainCard = ({
domain,
onRemove,
onPrepareOwnershipVerification,
isRemoveDisabled = false,
removeDisabledTooltip,
}: {
domain: OrganizationDomainResource;
onRemove: () => void;
onPrepareOwnershipVerification: () => Promise<void>;
isRemoveDisabled?: boolean;
removeDisabledTooltip?: ReturnType<typeof localizationKeys>;
}): JSX.Element | null => {
Expand All@@ -367,7 +381,8 @@ const DomainCard = ({

const ownershipVerification = domain.ownershipVerification;
const isVerified = ownershipVerification?.status === 'verified';
const cardId = isVerified ? 'verified' : 'unverified';
const isExpired = ownershipVerification?.status === 'expired';
const cardId = ownershipVerification?.status ?? 'unverified';

const removeButton = (
<Button
Expand DownExpand Up@@ -426,11 +441,13 @@ const DomainCard = ({
localizationKey={
isVerified
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__verified')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
: isExpired
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__expired')
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.badge__unverified')
}
/>

{!isVerified && (
{!isVerified && !isExpired && (
<Spinner
size='xs'
colorScheme='neutral'
Expand All@@ -451,7 +468,13 @@ const DomainCard = ({

<Box sx={{ overflow: 'hidden' }}>
<Animated>
{ownershipVerification?.verifiedAt ? (
{isExpired ? (
<ExpiredNotice
key='expired'
expiresAt={ownershipVerification?.expiresAt ?? null}
onPrepareOwnershipVerification={onPrepareOwnershipVerification}
/>
) : ownershipVerification?.verifiedAt ? (
<Text
key='verified'
as='p'
Expand All@@ -473,6 +496,57 @@ const DomainCard = ({
);
};

const ExpiredNotice = ({
expiresAt,
onPrepareOwnershipVerification,
}: {
expiresAt: Date | null;
onPrepareOwnershipVerification: () => Promise<void>;
}): JSX.Element => {
const [isVerifying, setIsVerifying] = useState(false);

const handleVerifyAgain = () => {
setIsVerifying(true);
void onPrepareOwnershipVerification().finally(() => setIsVerifying(false));
};

return (
<Col
elementDescriptor={descriptors.configureSSOVerifyDomainCardExpired}
sx={t => ({ gap: t.space.$3, paddingInline: t.space.$4, paddingBottom: t.space.$4 })}
>
<Text
as='p'
colorScheme='secondary'
localizationKey={
expiresAt
? localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredAtLabel', { date: expiresAt })
: localizationKeys('configureSSO.organizationDomainsStep.domainCard.expiredLabel')
}
/>

<Button
variant='bordered'
colorScheme='secondary'
size='xs'
isLoading={isVerifying}
onClick={handleVerifyAgain}
sx={t => ({ alignSelf: 'flex-start', gap: t.space.$1x5 })}
>
<Icon
icon={RotateLeftRight}
size='sm'
colorScheme='neutral'
/>
<Text
as='span'
localizationKey={localizationKeys('configureSSO.organizationDomainsStep.domainCard.verifyAgainButton')}
/>
</Button>
</Col>
);
};

const TxtRecord = ({
ownershipVerification,
}: {
Expand Down
1 change: 1 addition & 0 deletions packages/ui/src/customizables/elementDescriptors.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -586,6 +586,7 @@ export const APPEARANCE_KEYS = containsAllElementsConfigKeys([
'configureSSOVerifyDomainCardRemoveButton',
'configureSSOVerifyDomainCardTxtRecord',
'configureSSOVerifyDomainCardTxtRecordValue',
'configureSSOVerifyDomainCardExpired',
'configureSSOEmailVerificationForm',
'configureSSOEmailVerificationIcon',
'configureSSOEmailVerificationTitle',
Expand Down
5 changes: 3 additions & 2 deletions packages/ui/src/internal/appearance.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -717,11 +717,12 @@ export type ElementsConfig = {
configureSSOVerifyDomainErrorSubtitle: WithOptions;
configureSSOVerifyDomainList: WithOptions;
configureSSOVerifyDomainSuggestion: WithOptions;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified'>;
configureSSOVerifyDomainCard: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardBadge: WithOptions<'verified' | 'unverified' | 'expired'>;
configureSSOVerifyDomainCardRemoveButton: WithOptions;
configureSSOVerifyDomainCardTxtRecord: WithOptions;
configureSSOVerifyDomainCardTxtRecordValue: WithOptions;
configureSSOVerifyDomainCardExpired: WithOptions;
configureSSOEmailVerificationForm: WithOptions<string>;
configureSSOEmailVerificationIcon: WithOptions<string>;
configureSSOEmailVerificationTitle: WithOptions<string>;
Expand Down
Loading