Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(clerk-js): Rename userVerification to reverification #4634

Merged
merged 3 commits into from
Nov 22, 2024
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
10 changes: 5 additions & 5 deletions .changeset/friendly-chairs-tie.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
Drop experimental tag related to reverification.

Properties of Clerk class:
- `__experimental_openUserVerification` -> `__internal_openUserVerification`
- `__experimental_closeUserVerification` -> `__internal_closeUserVerification`
- `__experimental_UserVerificationProps` -> `__internal_UserVerificationProps`
- `__experimental_UserVerificationModalProps` -> `__internal_UserVerificationModalProps`
- `__experimental_openUserVerification` -> `__internal_openReverification`
- `__experimental_closeUserVerification` -> `__internal_closeReverification`
- `__experimental_UserVerificationProps` -> `__internal_ReverificationProps`
- `__experimental_UserVerificationModalProps` -> `__internal_ReverificationModalProps`

Properties of `Session`:
- `__experimental_factorVerificationAge` -> `factorVerificationAge`
Expand All @@ -30,4 +30,4 @@ Properties of `IntialState`:
- `__experimental_factorVerificationAge` -> `factorVerificationAge`

Localization types:
All properties of `__experimental_userVerification` are moved to `userVerification`
All properties of `__experimental_userVerification` are moved to `reverification`
8 changes: 4 additions & 4 deletions .changeset/hungry-beds-prove.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
Drop experimental tag related to reverification.

Properties of Clerk class:
- `__experimental_openUserVerification` -> `__internal_openUserVerification`
- `__experimental_closeUserVerification` -> `__internal_closeUserVerification`
- `__experimental_UserVerificationProps` -> `__internal_UserVerificationProps`
- `__experimental_UserVerificationModalProps` -> `__internal_UserVerificationModalProps`
- `__experimental_openUserVerification` -> `__internal_openReverification`
- `__experimental_closeUserVerification` -> `__internal_closeReverification`
- `__experimental_UserVerificationProps` -> `__internal_ReverificationProps`
- `__experimental_UserVerificationModalProps` -> `__internal_ReverificationModalProps`

Properties of `Session`:
- `__experimental_factorVerificationAge` -> `factorVerificationAge`
Expand Down
2 changes: 1 addition & 1 deletion .changeset/small-suits-knock.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
'@clerk/localizations': minor
---

Moves all properties under `__experimental_userVerification` to `userVerification`. This affects all languages.
Moves all properties under `__experimental_userVerification` to `reverification`. This affects all languages.
9 changes: 9 additions & 0 deletions .changeset/strange-days-kneel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
'@clerk/localizations': patch
'@clerk/clerk-js': patch
'@clerk/shared': patch
'@clerk/clerk-react': patch
'@clerk/types': patch
---

Rename userVerification to reverification to align with the feature name.
4 changes: 2 additions & 2 deletions packages/clerk-js/src/core/clerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ export class Clerk implements ClerkInterface {
void this.#componentControls.ensureMounted().then(controls => controls.closeModal('signIn'));
};

public __internal_openUserVerification = (props?: __internal_UserVerificationModalProps): void => {
public __internal_openReverification = (props?: __internal_UserVerificationModalProps): void => {
this.assertComponentsReady(this.#componentControls);
if (noUserExists(this)) {
if (this.#instanceType === 'development') {
Expand All @@ -440,7 +440,7 @@ export class Clerk implements ClerkInterface {
.then(controls => controls.openModal('userVerification', props || {}));
};

public __internal_closeUserVerification = (): void => {
public __internal_closeReverification = (): void => {
this.assertComponentsReady(this.#componentControls);
void this.#componentControls.ensureMounted().then(controls => controls.closeModal('userVerification'));
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
<Card.Root>
<Card.Content>
<Header.Root showLogo>
<Header.Title localizationKey={localizationKeys('userVerification.alternativeMethods.title')} />
<Header.Subtitle localizationKey={localizationKeys('userVerification.alternativeMethods.subtitle')} />
<Header.Title localizationKey={localizationKeys('reverification.alternativeMethods.title')} />
<Header.Subtitle localizationKey={localizationKeys('reverification.alternativeMethods.subtitle')} />
</Header.Root>
<Card.Alert>{card.error}</Card.Alert>
{/*TODO: extract main in its own component */}
Expand Down Expand Up @@ -87,9 +87,9 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {

<Card.Footer>
<Card.Action elementId='havingTrouble'>
<Card.ActionText localizationKey={localizationKeys('userVerification.alternativeMethods.actionText')} />
<Card.ActionText localizationKey={localizationKeys('reverification.alternativeMethods.actionText')} />
<Card.ActionLink
localizationKey={localizationKeys('userVerification.alternativeMethods.actionLink')}
localizationKey={localizationKeys('reverification.alternativeMethods.actionLink')}
onClick={onHavingTroubleClick}
/>
</Card.Action>
Expand All @@ -102,15 +102,15 @@ const AlternativeMethodsList = (props: AlternativeMethodListProps) => {
export function getButtonLabel(factor: SessionVerificationFirstFactor): LocalizationKey {
switch (factor.strategy) {
case 'email_code':
return localizationKeys('userVerification.alternativeMethods.blockButton__emailCode', {
return localizationKeys('reverification.alternativeMethods.blockButton__emailCode', {
identifier: formatSafeIdentifier(factor.safeIdentifier) || '',
});
case 'phone_code':
return localizationKeys('userVerification.alternativeMethods.blockButton__phoneCode', {
return localizationKeys('reverification.alternativeMethods.blockButton__phoneCode', {
identifier: formatSafeIdentifier(factor.safeIdentifier) || '',
});
case 'password':
return localizationKeys('userVerification.alternativeMethods.blockButton__password');
return localizationKeys('reverification.alternativeMethods.blockButton__password');
default:
throw `Invalid sign in strategy: "${(factor as any).strategy}"`;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ export const HavingTrouble = (props: PropsOfComponent<typeof ErrorCard>) => {

return (
<ErrorCard
cardTitle={localizationKeys('userVerification.alternativeMethods.getHelp.title')}
cardSubtitle={localizationKeys('userVerification.alternativeMethods.getHelp.content')}
cardTitle={localizationKeys('reverification.alternativeMethods.getHelp.title')}
cardSubtitle={localizationKeys('reverification.alternativeMethods.getHelp.content')}
onBackLinkClick={onBackLinkClick}
/>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ export const UVFactorOneEmailCodeCard = (props: UVFactorOneEmailCodeCardProps) =
<Flow.Part part='emailCode'>
<UVFactorOneCodeForm
{...props}
cardTitle={localizationKeys('userVerification.emailCode.title')}
cardSubtitle={localizationKeys('userVerification.emailCode.subtitle')}
inputLabel={localizationKeys('userVerification.emailCode.formTitle')}
resendButton={localizationKeys('userVerification.emailCode.resendButton')}
cardTitle={localizationKeys('reverification.emailCode.title')}
cardSubtitle={localizationKeys('reverification.emailCode.subtitle')}
inputLabel={localizationKeys('reverification.emailCode.formTitle')}
resendButton={localizationKeys('reverification.emailCode.resendButton')}
/>
</Flow.Part>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ export const UVFactorOnePhoneCodeCard = (props: UVFactorOnePhoneCodeCardProps) =
<Flow.Part part='phoneCode'>
<UVFactorOneCodeForm
{...props}
cardTitle={localizationKeys('userVerification.phoneCode.title')}
cardSubtitle={localizationKeys('userVerification.phoneCode.subtitle')}
inputLabel={localizationKeys('userVerification.phoneCode.formTitle')}
resendButton={localizationKeys('userVerification.phoneCode.resendButton')}
cardTitle={localizationKeys('reverification.phoneCode.title')}
cardSubtitle={localizationKeys('reverification.phoneCode.subtitle')}
inputLabel={localizationKeys('reverification.phoneCode.formTitle')}
resendButton={localizationKeys('reverification.phoneCode.resendButton')}
/>
</Flow.Part>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ const AlternativeMethodsList = (props: AlternativeMethodsProps & { onHavingTroub
<Card.Root>
<Card.Content>
<Header.Root showLogo>
<Header.Title localizationKey={localizationKeys('userVerification.alternativeMethods.title')} />
<Header.Subtitle localizationKey={localizationKeys('userVerification.alternativeMethods.subtitle')} />
<Header.Title localizationKey={localizationKeys('reverification.alternativeMethods.title')} />
<Header.Subtitle localizationKey={localizationKeys('reverification.alternativeMethods.subtitle')} />
</Header.Root>
<Card.Alert>{card.error}</Card.Alert>
{/*TODO: extract main in its own component */}
Expand Down Expand Up @@ -76,9 +76,9 @@ const AlternativeMethodsList = (props: AlternativeMethodsProps & { onHavingTroub

<Card.Footer>
<Card.Action elementId='havingTrouble'>
<Card.ActionText localizationKey={localizationKeys('userVerification.alternativeMethods.actionText')} />
<Card.ActionText localizationKey={localizationKeys('reverification.alternativeMethods.actionText')} />
<Card.ActionLink
localizationKey={localizationKeys('userVerification.alternativeMethods.actionLink')}
localizationKey={localizationKeys('reverification.alternativeMethods.actionLink')}
onClick={onHavingTroubleClick}
/>
</Card.Action>
Expand All @@ -91,13 +91,13 @@ const AlternativeMethodsList = (props: AlternativeMethodsProps & { onHavingTroub
export function getButtonLabel(factor: SessionVerificationSecondFactor): LocalizationKey {
switch (factor.strategy) {
case 'phone_code':
return localizationKeys('userVerification.alternativeMethods.blockButton__phoneCode', {
return localizationKeys('reverification.alternativeMethods.blockButton__phoneCode', {
identifier: formatSafeIdentifier(factor.safeIdentifier) || '',
});
case 'totp':
return localizationKeys('userVerification.alternativeMethods.blockButton__totp');
return localizationKeys('reverification.alternativeMethods.blockButton__totp');
case 'backup_code':
return localizationKeys('userVerification.alternativeMethods.blockButton__backupCode');
return localizationKeys('reverification.alternativeMethods.blockButton__backupCode');
default:
throw `Invalid verification strategy: "${(factor as any).strategy}"`;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ export const UVFactorTwoBackupCodeCard = (props: UVFactorTwoBackupCodeCardProps)
<Card.Root>
<Card.Content>
<Header.Root showLogo>
<Header.Title localizationKey={localizationKeys('userVerification.backupCodeMfa.title')} />
<Header.Subtitle localizationKey={localizationKeys('userVerification.backupCodeMfa.subtitle')} />
<Header.Title localizationKey={localizationKeys('reverification.backupCodeMfa.title')} />
<Header.Subtitle localizationKey={localizationKeys('reverification.backupCodeMfa.subtitle')} />
</Header.Root>
<Card.Alert>{card.error}</Card.Alert>
<Col
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ export const UVFactorTwoPhoneCodeCard = (props: UVFactorTwoPhoneCodeCardProps) =
<Flow.Part part='phoneCode2Fa'>
<UVFactorTwoCodeForm
{...props}
cardTitle={localizationKeys('userVerification.phoneCodeMfa.title')}
cardSubtitle={localizationKeys('userVerification.phoneCodeMfa.subtitle')}
inputLabel={localizationKeys('userVerification.phoneCodeMfa.formTitle')}
resendButton={localizationKeys('userVerification.phoneCodeMfa.resendButton')}
cardTitle={localizationKeys('reverification.phoneCodeMfa.title')}
cardSubtitle={localizationKeys('reverification.phoneCodeMfa.subtitle')}
inputLabel={localizationKeys('reverification.phoneCodeMfa.formTitle')}
resendButton={localizationKeys('reverification.phoneCodeMfa.resendButton')}
prepare={prepare}
/>
</Flow.Part>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ export function _UserVerificationFactorOne(): JSX.Element | null {
if (!currentFactor) {
return (
<ErrorCard
cardTitle={localizationKeys('userVerification.noAvailableMethods.title')}
cardSubtitle={localizationKeys('userVerification.noAvailableMethods.subtitle')}
message={localizationKeys('userVerification.noAvailableMethods.message')}
cardTitle={localizationKeys('reverification.noAvailableMethods.title')}
cardSubtitle={localizationKeys('reverification.noAvailableMethods.subtitle')}
message={localizationKeys('reverification.noAvailableMethods.message')}
shouldNavigateBack={false}
/>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ export function UserVerificationFactorOnePasswordCard(props: UserVerificationFac
<Card.Root>
<Card.Content>
<Header.Root showLogo>
<Header.Title localizationKey={localizationKeys('userVerification.password.title')} />
<Header.Subtitle localizationKey={localizationKeys('userVerification.password.subtitle')} />
<Header.Title localizationKey={localizationKeys('reverification.password.title')} />
<Header.Subtitle localizationKey={localizationKeys('reverification.password.subtitle')} />
</Header.Root>
<Card.Alert>{card.error}</Card.Alert>
<Col
Expand Down Expand Up @@ -80,8 +80,8 @@ export function UserVerificationFactorOnePasswordCard(props: UserVerificationFac
<Card.ActionLink
localizationKey={localizationKeys(
onShowAlternativeMethodsClick
? 'userVerification.password.actionLink'
: 'userVerification.alternativeMethods.actionLink',
? 'reverification.password.actionLink'
: 'reverification.alternativeMethods.actionLink',
)}
onClick={onShowAlternativeMethodsClick || toggleHavingTrouble}
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ export function UserVerificationFactorTwoTOTP(props: UVFactorTwoTOTPCardProps):
<Flow.Part part='totp2Fa'>
<UVFactorTwoCodeForm
{...props}
cardTitle={localizationKeys('userVerification.totpMfa.title')}
cardSubtitle={localizationKeys('userVerification.totpMfa.subtitle')}
inputLabel={localizationKeys('userVerification.totpMfa.formTitle')}
cardTitle={localizationKeys('reverification.totpMfa.title')}
cardSubtitle={localizationKeys('reverification.totpMfa.subtitle')}
inputLabel={localizationKeys('reverification.totpMfa.formTitle')}
/>
</Flow.Part>
);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ describe('UserVerificationFactorOne', () => {
const { getByLabelText, getByText } = render(<UserVerificationFactorOne />, { wrapper });

await waitFor(() => {
getByText('Enter your password');
getByText('Enter the password associated with your account');
getByText('Verification required');
getByText('Enter your password to continue');
getByLabelText(/^password/i);
});
});
Expand All @@ -46,7 +46,7 @@ describe('UserVerificationFactorOne', () => {
const { getByLabelText, getByText } = render(<UserVerificationFactorOne />, { wrapper });

await waitFor(() => {
getByText('Check your email');
getByText('Verification required');
getByLabelText(/Enter verification code/i);
});

Expand All @@ -66,7 +66,7 @@ describe('UserVerificationFactorOne', () => {
const { getByLabelText, getByText } = render(<UserVerificationFactorOne />, { wrapper });

await waitFor(() => {
getByText('Check your phone');
getByText('Verification required');
getByLabelText(/Enter verification code/i);
});

Expand All @@ -93,7 +93,7 @@ describe('UserVerificationFactorOne', () => {

const { userEvent, getByLabelText, getByText } = render(<UserVerificationFactorOne />, { wrapper });

await waitFor(() => getByText('Enter your password'));
await waitFor(() => getByText('Verification required'));
await userEvent.type(getByLabelText(/^password/i), 'testtest');
await userEvent.click(getByText('Continue'));

Expand Down Expand Up @@ -123,7 +123,7 @@ describe('UserVerificationFactorOne', () => {

const { userEvent, getByLabelText, getByText } = render(<UserVerificationFactorOne />, { wrapper });

await waitFor(() => getByText('Enter your password'));
await waitFor(() => getByText('Verification required'));
await userEvent.type(getByLabelText(/^password/i), 'testtest');
await userEvent.click(screen.getByText('Continue'));

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ describe('UserVerificationFactorTwo', () => {
const { getByText, getAllByLabelText } = render(<UserVerificationFactorTwo />, { wrapper });

await waitFor(() => {
getByText('Check your phone');
getByText('Verification required');
const inputs = getAllByLabelText(/digit/i);
expect(inputs.length).toBe(6);
});
Expand All @@ -55,8 +55,8 @@ describe('UserVerificationFactorTwo', () => {
const { getByLabelText, getByText } = render(<UserVerificationFactorTwo />, { wrapper });

await waitFor(() => {
getByText('Two-step verification');
getByText('To continue, please enter the verification code generated by your authenticator app');
getByText('Verification required');
getByText('Enter the code generated by your authenticator app to continue');
getByLabelText(/Enter verification code/i);
});
});
Expand All @@ -78,7 +78,7 @@ describe('UserVerificationFactorTwo', () => {

await waitFor(() => {
getByText('Enter a backup code');
getByText('Your backup code is the one you got when setting up two-step authentication.');
getByText('Enter the backup code you received when setting up two-step authentication');
getByLabelText(/Backup code/i);
});
});
Expand Down Expand Up @@ -123,7 +123,7 @@ describe('UserVerificationFactorTwo', () => {
await runFakeTimers(async timers => {
const { userEvent, getByLabelText, getByText } = render(<UserVerificationFactorTwo />, { wrapper });

await waitFor(() => getByText('Check your phone'));
await waitFor(() => getByText('Verification required'));

await userEvent.type(getByLabelText(/Enter verification code/i), '123456');
timers.runOnlyPendingTimers();
Expand Down
2 changes: 1 addition & 1 deletion packages/localizations/src/ar-SA.ts
Original file line number Diff line number Diff line change
Expand Up @@ -846,7 +846,7 @@ export const arSA: LocalizationResource = {
web3WalletButtonsBlockButton: undefined,
},
},
userVerification: {
reverification: {
alternativeMethods: {
actionLink: undefined,
actionText: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/localizations/src/be-BY.ts
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,7 @@ export const beBY: LocalizationResource = {
web3WalletButtonsBlockButton: undefined,
},
},
userVerification: {
reverification: {
alternativeMethods: {
actionLink: undefined,
actionText: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/localizations/src/bg-BG.ts
Original file line number Diff line number Diff line change
Expand Up @@ -853,7 +853,7 @@ export const bgBG: LocalizationResource = {
web3WalletButtonsBlockButton: undefined,
},
},
userVerification: {
reverification: {
alternativeMethods: {
actionLink: undefined,
actionText: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/localizations/src/cs-CZ.ts
Original file line number Diff line number Diff line change
Expand Up @@ -849,7 +849,7 @@ export const csCZ: LocalizationResource = {
web3WalletButtonsBlockButton: undefined,
},
},
userVerification: {
reverification: {
alternativeMethods: {
actionLink: undefined,
actionText: undefined,
Expand Down
2 changes: 1 addition & 1 deletion packages/localizations/src/da-DK.ts
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@ export const daDK: LocalizationResource = {
web3WalletButtonsBlockButton: undefined,
},
},
userVerification: {
reverification: {
alternativeMethods: {
actionLink: undefined,
actionText: undefined,
Expand Down
Loading
Loading