chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

Sign up for GitHub

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

Merged
panteliselef merged 16 commits into from
Jun 17, 2025
Merged

chore(clerk-js, localizations): Improve type safety of localizationKeys() with params #6108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
17f0984
wip
panteliselef Jun 12, 2025
7ab2bd9
improve export type names
panteliselef Jun 12, 2025
8b7bf44
make it stricter
panteliselef Jun 12, 2025
d8ff4a8
cleanup
panteliselef Jun 13, 2025
d8e5f31
revert WithParams on top level only
panteliselef Jun 13, 2025
107d27d
Merge branch 'main' into elef/improve-localization-keys-dx
panteliselef Jun 13, 2025
74ef558
changeset
panteliselef Jun 13, 2025
4116e05
fix lock file
panteliselef Jun 13, 2025
fbe1ede
address todo comments
panteliselef Jun 13, 2025
1cc756e
Merge branch 'main' into elef/improve-localization-keys-dx
panteliselef Jun 13, 2025
e22a9ce
Merge branch 'main' into elef/improve-localization-keys-dx
panteliselef Jun 13, 2025
061d302
bump bundle
panteliselef Jun 13, 2025
e4623f1
remove comments
panteliselef Jun 13, 2025
2be8606
Merge branch 'main' into elef/improve-localization-keys-dx
panteliselef Jun 17, 2025
34dfae4
resolve conflicts
panteliselef Jun 17, 2025
ea97fa8
improve changeset
panteliselef Jun 17, 2025
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
5 changes: 5 additions & 0 deletions .changeset/cold-turtles-press.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.
2 changes: 1 addition & 1 deletion packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
{ "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
{ "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
{ "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
{ "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
{ "path": "./dist/coinbase*.js", "maxSize": "38KB" },
{ "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
onOpen: () => void;
onClose: () => void;
apiKeyId?: string;
apiKeyName?: string;
apiKeyName: string;
modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down
14 changes: 6 additions & 8 deletions packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

return (
<ActionConfirmationPage
organizationName={organization?.name}
organizationName={organization.name}
title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
actionDescription={localizationKeys(
'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
{ organizationName: organization?.name },
{ organizationName: organization.name },
)}
submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

return (
<ActionConfirmationPage
organizationName={organization?.name}
organizationName={organization.name}
title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
actionDescription={localizationKeys(
'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
{ organizationName: organization?.name },
{ organizationName: organization.name },
)}
submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
title: LocalizationKey;
messageLine1: LocalizationKey;
messageLine2: LocalizationKey;
actionDescription?: LocalizationKey;
actionDescription: LocalizationKey;
organizationName?: string;
successMessage: LocalizationKey;
submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
type: 'text',
label:
actionDescription ||
localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
label: actionDescription,
isRequired: true,
placeholder: organizationName,
});
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
<RemoveResourceForm
title={localizationKeys('organizationProfile.removeDomainPage.title')}
messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
domain: ref.current?.name,
domain: ref.current?.name || '',
})}
messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
deleteResource={() =>
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
}, [domain?.id]);

const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
domain: domain?.name,
domain: domain?.name || '',
});
const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
domain: domain?.name,
domain: domain?.name || '',
});

const calloutLabel = useCalloutLabel(domain, {
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
const subtitleVerificationCodeScreen = localizationKeys(
'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
{
emailAddress: affiliationEmailAddressRef.current,
emailAddress: affiliationEmailAddressRef.current || '',
},
);

Expand Down
6 changes: 4 additions & 2 deletions packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
order: ctaPosition === 'top' ? -1 : undefined,
})}
>
{shouldShowFooterNotice ? (
{shouldShowFooterNotice && subscription ? (
<Text
elementDescriptor={descriptors.pricingTableCardFooterNotice}
variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
localizationKey={localizationKeys('badge__startsAt', {
date: subscription?.periodStart,
})}
colorScheme='secondary'
sx={t => ({
paddingBlock: t.space.$1x5,
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
<SignInFactorOneAlternativeChannelCodeForm
{...props}
cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
})}
cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down
6 changes: 4 additions & 2 deletions packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

if (isAlternativePhoneCodeProvider) {
const provider = getAlternativePhoneCodeProviderData(channel)?.name;
cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
provider: provider || '',
});
resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
}

Expand Down
4 changes: 3 additions & 1 deletion ...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
<Form.ControlRow elementId='phoneNumber'>
<Form.PhoneInput
{...formState.phoneNumber.props}
label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
provider: provider || '',
})}
isRequired
isOptional={false}
actionLabel={undefined}
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
<FormContainer
headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
identifier: emailAddressRef.current?.emailAddress,
identifier: emailAddressRef.current?.emailAddress || '',
})}
>
{strategy === 'email_link' && (
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
<FormContainer
headerTitle={title}
headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
identifier: resourceRef.current?.phoneNumber,
identifier: resourceRef.current?.phoneNumber || '',
})}
>
<VerifyWithCode
Expand Down
2 changes: 1 addition & 1 deletion packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
<FormContainer
headerTitle={title}
headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
identifier: resourceRef.current?.phoneNumber,
identifier: resourceRef.current?.phoneNumber || '',
})}
>
<VerifyWithCode
Expand Down
6 changes: 3 additions & 3 deletions packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
<RemoveResourceForm
title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
identifier: providerToDisplayData[ref.current]?.name,
identifier: providerToDisplayData[ref.current]?.name || '',
})}
messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
connectedAccount: providerToDisplayData[ref.current]?.name,
connectedAccount: providerToDisplayData[ref.current]?.name || '',
})}
deleteResource={() => Promise.resolve(resource?.destroy())}
onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
<RemoveResourceForm
title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
name: passkey.name,
name: passkey.name || '',
})}
deleteResource={passkey.delete}
onSuccess={onSuccess}
Expand Down
4 changes: 3 additions & 1 deletion packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
<Form.OTPInput
{...otp}
label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
identifier: identifier || '',
})}
resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
centerAlign={false}
/>
Expand Down
8 changes: 4 additions & 4 deletions packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

if (termsUrl && privacyPolicyUrl) {
localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
termsOfServiceLink: props.termsUrl,
privacyPolicyLink: props.privacyPolicyUrl,
termsOfServiceLink: termsUrl,
privacyPolicyLink: privacyPolicyUrl,
});
} else if (termsUrl) {
localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
termsOfServiceLink: props.termsUrl,
termsOfServiceLink: termsUrl,
});
} else if (privacyPolicyUrl) {
localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
privacyPolicyLink: props.privacyPolicyUrl,
privacyPolicyLink: privacyPolicyUrl,
});
}

Expand Down
19 changes: 8 additions & 11 deletions packages/clerk-js/src/ui/localization/localizationKeys.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
key: string;
params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
return { key, params } as LocalizationKey;
return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.
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
chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 16 commits into

from

Jun 17, 2025
 Merged


chore(clerk-js, localizations): Improve type safety of localizationKeys() with params
#6108
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
17f0984

wip


panteliselef Jun 12, 2025
7ab2bd9

improve export type names


panteliselef Jun 12, 2025
8b7bf44

make it stricter


panteliselef Jun 12, 2025
d8ff4a8

cleanup


panteliselef Jun 13, 2025
d8e5f31

revert WithParams on top level only


panteliselef Jun 13, 2025
107d27d

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
74ef558

changeset


panteliselef Jun 13, 2025
4116e05

fix lock file


panteliselef Jun 13, 2025
fbe1ede

address todo comments


panteliselef Jun 13, 2025
1cc756e

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
e22a9ce

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
061d302

bump bundle


panteliselef Jun 13, 2025
e4623f1

remove comments


panteliselef Jun 13, 2025
2be8606

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 17, 2025
34dfae4

resolve conflicts


panteliselef Jun 17, 2025
ea97fa8

improve changeset


panteliselef Jun 17, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/cold-turtles-press.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
 onOpen: () => void;
 onClose: () => void;
 apiKeyId?: string;
 apiKeyName?: string;
 apiKeyName: string;
 modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down

14 changes: 6 additions & 8 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
 title: LocalizationKey;
 messageLine1: LocalizationKey;
 messageLine2: LocalizationKey;
 actionDescription?: LocalizationKey;
 actionDescription: LocalizationKey;
 organizationName?: string;
 successMessage: LocalizationKey;
 submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

 const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
 type: 'text',
 label:
 actionDescription ||
 localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
 label: actionDescription,
 isRequired: true,
 placeholder: organizationName,
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('organizationProfile.removeDomainPage.title')}
 messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
 domain: ref.current?.name,
 domain: ref.current?.name || '',
 })}
 messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
 deleteResource={() =>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
 }, [domain?.id]);

 const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
 domain: domain?.name,
 domain: domain?.name || '',
 });
 const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
 domain: domain?.name,
 domain: domain?.name || '',
 });

 const calloutLabel = useCalloutLabel(domain, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
 const subtitleVerificationCodeScreen = localizationKeys(
 'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
 {
 emailAddress: affiliationEmailAddressRef.current,
 emailAddress: affiliationEmailAddressRef.current || '',
 },
 );

Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
 order: ctaPosition === 'top' ? -1 : undefined,
 })}
 >
 {shouldShowFooterNotice ? (
 {shouldShowFooterNotice && subscription ? (
 <Text
 elementDescriptor={descriptors.pricingTableCardFooterNotice}
 variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
 localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
 localizationKey={localizationKeys('badge__startsAt', {
 date: subscription?.periodStart,
 })}
 colorScheme='secondary'
 sx={t => ({
 paddingBlock: t.space.$1x5,
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
 <SignInFactorOneAlternativeChannelCodeForm
 {...props}
 cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
 })}
 cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
 inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

 if (isAlternativePhoneCodeProvider) {
 const provider = getAlternativePhoneCodeProviderData(channel)?.name;
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
 provider: provider || '',
 });
 resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
 }

Expand Down

4 changes: 3 additions & 1 deletion
...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
 <Form.ControlRow elementId='phoneNumber'>
 <Form.PhoneInput
 {...formState.phoneNumber.props}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
 provider: provider || '',
 })}
 isRequired
 isOptional={false}
 actionLabel={undefined}
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
 <FormContainer
 headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
 headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
 identifier: emailAddressRef.current?.emailAddress,
 identifier: emailAddressRef.current?.emailAddress || '',
 })}
 >
 {strategy === 'email_link' && (
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
 <RemoveResourceForm
 title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
 messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
 identifier: providerToDisplayData[ref.current]?.name,
 identifier: providerToDisplayData[ref.current]?.name || '',
 })}
 messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
 successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
 connectedAccount: providerToDisplayData[ref.current]?.name,
 connectedAccount: providerToDisplayData[ref.current]?.name || '',
 })}
 deleteResource={() => Promise.resolve(resource?.destroy())}
 onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
 messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
 name: passkey.name,
 name: passkey.name || '',
 })}
 deleteResource={passkey.delete}
 onSuccess={onSuccess}
Expand Down

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
 <Form.OTPInput
 {...otp}
 label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
 identifier: identifier || '',
 })}
 resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
 centerAlign={false}
 />
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

 if (termsUrl && privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
 termsOfServiceLink: props.termsUrl,
 privacyPolicyLink: props.privacyPolicyUrl,
 termsOfServiceLink: termsUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 } else if (termsUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
 termsOfServiceLink: props.termsUrl,
 termsOfServiceLink: termsUrl,
 });
 } else if (privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
 privacyPolicyLink: props.privacyPolicyUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 }

Expand Down

19 changes: 8 additions & 11 deletions
packages/clerk-js/src/ui/localization/localizationKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
 T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
 key: string;
 params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
 key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
 return { key, params } as LocalizationKey;
 return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.

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
chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 16 commits into

from

Jun 17, 2025
 Merged


chore(clerk-js, localizations): Improve type safety of localizationKeys() with params
#6108
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
17f0984

wip


panteliselef Jun 12, 2025
7ab2bd9

improve export type names


panteliselef Jun 12, 2025
8b7bf44

make it stricter


panteliselef Jun 12, 2025
d8ff4a8

cleanup


panteliselef Jun 13, 2025
d8e5f31

revert WithParams on top level only


panteliselef Jun 13, 2025
107d27d

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
74ef558

changeset


panteliselef Jun 13, 2025
4116e05

fix lock file


panteliselef Jun 13, 2025
fbe1ede

address todo comments


panteliselef Jun 13, 2025
1cc756e

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
e22a9ce

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
061d302

bump bundle


panteliselef Jun 13, 2025
e4623f1

remove comments


panteliselef Jun 13, 2025
2be8606

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 17, 2025
34dfae4

resolve conflicts


panteliselef Jun 17, 2025
ea97fa8

improve changeset


panteliselef Jun 17, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/cold-turtles-press.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
 onOpen: () => void;
 onClose: () => void;
 apiKeyId?: string;
 apiKeyName?: string;
 apiKeyName: string;
 modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down

14 changes: 6 additions & 8 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
 title: LocalizationKey;
 messageLine1: LocalizationKey;
 messageLine2: LocalizationKey;
 actionDescription?: LocalizationKey;
 actionDescription: LocalizationKey;
 organizationName?: string;
 successMessage: LocalizationKey;
 submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

 const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
 type: 'text',
 label:
 actionDescription ||
 localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
 label: actionDescription,
 isRequired: true,
 placeholder: organizationName,
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('organizationProfile.removeDomainPage.title')}
 messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
 domain: ref.current?.name,
 domain: ref.current?.name || '',
 })}
 messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
 deleteResource={() =>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
 }, [domain?.id]);

 const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
 domain: domain?.name,
 domain: domain?.name || '',
 });
 const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
 domain: domain?.name,
 domain: domain?.name || '',
 });

 const calloutLabel = useCalloutLabel(domain, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
 const subtitleVerificationCodeScreen = localizationKeys(
 'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
 {
 emailAddress: affiliationEmailAddressRef.current,
 emailAddress: affiliationEmailAddressRef.current || '',
 },
 );

Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
 order: ctaPosition === 'top' ? -1 : undefined,
 })}
 >
 {shouldShowFooterNotice ? (
 {shouldShowFooterNotice && subscription ? (
 <Text
 elementDescriptor={descriptors.pricingTableCardFooterNotice}
 variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
 localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
 localizationKey={localizationKeys('badge__startsAt', {
 date: subscription?.periodStart,
 })}
 colorScheme='secondary'
 sx={t => ({
 paddingBlock: t.space.$1x5,
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
 <SignInFactorOneAlternativeChannelCodeForm
 {...props}
 cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
 })}
 cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
 inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

 if (isAlternativePhoneCodeProvider) {
 const provider = getAlternativePhoneCodeProviderData(channel)?.name;
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
 provider: provider || '',
 });
 resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
 }

Expand Down

4 changes: 3 additions & 1 deletion
...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
 <Form.ControlRow elementId='phoneNumber'>
 <Form.PhoneInput
 {...formState.phoneNumber.props}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
 provider: provider || '',
 })}
 isRequired
 isOptional={false}
 actionLabel={undefined}
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
 <FormContainer
 headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
 headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
 identifier: emailAddressRef.current?.emailAddress,
 identifier: emailAddressRef.current?.emailAddress || '',
 })}
 >
 {strategy === 'email_link' && (
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
 <RemoveResourceForm
 title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
 messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
 identifier: providerToDisplayData[ref.current]?.name,
 identifier: providerToDisplayData[ref.current]?.name || '',
 })}
 messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
 successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
 connectedAccount: providerToDisplayData[ref.current]?.name,
 connectedAccount: providerToDisplayData[ref.current]?.name || '',
 })}
 deleteResource={() => Promise.resolve(resource?.destroy())}
 onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
 messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
 name: passkey.name,
 name: passkey.name || '',
 })}
 deleteResource={passkey.delete}
 onSuccess={onSuccess}
Expand Down

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
 <Form.OTPInput
 {...otp}
 label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
 identifier: identifier || '',
 })}
 resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
 centerAlign={false}
 />
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

 if (termsUrl && privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
 termsOfServiceLink: props.termsUrl,
 privacyPolicyLink: props.privacyPolicyUrl,
 termsOfServiceLink: termsUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 } else if (termsUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
 termsOfServiceLink: props.termsUrl,
 termsOfServiceLink: termsUrl,
 });
 } else if (privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
 privacyPolicyLink: props.privacyPolicyUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 }

Expand Down

19 changes: 8 additions & 11 deletions
packages/clerk-js/src/ui/localization/localizationKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
 T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
 key: string;
 params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
 key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
 return { key, params } as LocalizationKey;
 return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.

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
chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 16 commits into

from

Jun 17, 2025
 Merged


chore(clerk-js, localizations): Improve type safety of localizationKeys() with params
#6108
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
17f0984

wip


panteliselef Jun 12, 2025
7ab2bd9

improve export type names


panteliselef Jun 12, 2025
8b7bf44

make it stricter


panteliselef Jun 12, 2025
d8ff4a8

cleanup


panteliselef Jun 13, 2025
d8e5f31

revert WithParams on top level only


panteliselef Jun 13, 2025
107d27d

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
74ef558

changeset


panteliselef Jun 13, 2025
4116e05

fix lock file


panteliselef Jun 13, 2025
fbe1ede

address todo comments


panteliselef Jun 13, 2025
1cc756e

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
e22a9ce

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
061d302

bump bundle


panteliselef Jun 13, 2025
e4623f1

remove comments


panteliselef Jun 13, 2025
2be8606

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 17, 2025
34dfae4

resolve conflicts


panteliselef Jun 17, 2025
ea97fa8

improve changeset


panteliselef Jun 17, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/cold-turtles-press.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
 onOpen: () => void;
 onClose: () => void;
 apiKeyId?: string;
 apiKeyName?: string;
 apiKeyName: string;
 modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down

14 changes: 6 additions & 8 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
 title: LocalizationKey;
 messageLine1: LocalizationKey;
 messageLine2: LocalizationKey;
 actionDescription?: LocalizationKey;
 actionDescription: LocalizationKey;
 organizationName?: string;
 successMessage: LocalizationKey;
 submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

 const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
 type: 'text',
 label:
 actionDescription ||
 localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
 label: actionDescription,
 isRequired: true,
 placeholder: organizationName,
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('organizationProfile.removeDomainPage.title')}
 messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
 domain: ref.current?.name,
 domain: ref.current?.name || '',
 })}
 messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
 deleteResource={() =>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
 }, [domain?.id]);

 const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
 domain: domain?.name,
 domain: domain?.name || '',
 });
 const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
 domain: domain?.name,
 domain: domain?.name || '',
 });

 const calloutLabel = useCalloutLabel(domain, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
 const subtitleVerificationCodeScreen = localizationKeys(
 'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
 {
 emailAddress: affiliationEmailAddressRef.current,
 emailAddress: affiliationEmailAddressRef.current || '',
 },
 );

Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
 order: ctaPosition === 'top' ? -1 : undefined,
 })}
 >
 {shouldShowFooterNotice ? (
 {shouldShowFooterNotice && subscription ? (
 <Text
 elementDescriptor={descriptors.pricingTableCardFooterNotice}
 variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
 localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
 localizationKey={localizationKeys('badge__startsAt', {
 date: subscription?.periodStart,
 })}
 colorScheme='secondary'
 sx={t => ({
 paddingBlock: t.space.$1x5,
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
 <SignInFactorOneAlternativeChannelCodeForm
 {...props}
 cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
 })}
 cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
 inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

 if (isAlternativePhoneCodeProvider) {
 const provider = getAlternativePhoneCodeProviderData(channel)?.name;
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
 provider: provider || '',
 });
 resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
 }

Expand Down

4 changes: 3 additions & 1 deletion
...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
 <Form.ControlRow elementId='phoneNumber'>
 <Form.PhoneInput
 {...formState.phoneNumber.props}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
 provider: provider || '',
 })}
 isRequired
 isOptional={false}
 actionLabel={undefined}
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
 <FormContainer
 headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
 headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
 identifier: emailAddressRef.current?.emailAddress,
 identifier: emailAddressRef.current?.emailAddress || '',
 })}
 >
 {strategy === 'email_link' && (
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
 <RemoveResourceForm
 title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
 messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
 identifier: providerToDisplayData[ref.current]?.name,
 identifier: providerToDisplayData[ref.current]?.name || '',
 })}
 messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
 successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
 connectedAccount: providerToDisplayData[ref.current]?.name,
 connectedAccount: providerToDisplayData[ref.current]?.name || '',
 })}
 deleteResource={() => Promise.resolve(resource?.destroy())}
 onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
 messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
 name: passkey.name,
 name: passkey.name || '',
 })}
 deleteResource={passkey.delete}
 onSuccess={onSuccess}
Expand Down

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
 <Form.OTPInput
 {...otp}
 label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
 identifier: identifier || '',
 })}
 resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
 centerAlign={false}
 />
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

 if (termsUrl && privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
 termsOfServiceLink: props.termsUrl,
 privacyPolicyLink: props.privacyPolicyUrl,
 termsOfServiceLink: termsUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 } else if (termsUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
 termsOfServiceLink: props.termsUrl,
 termsOfServiceLink: termsUrl,
 });
 } else if (privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
 privacyPolicyLink: props.privacyPolicyUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 }

Expand Down

19 changes: 8 additions & 11 deletions
packages/clerk-js/src/ui/localization/localizationKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
 T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
 key: string;
 params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
 key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
 return { key, params } as LocalizationKey;
 return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.

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
chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 16 commits into

from

Jun 17, 2025
 Merged


chore(clerk-js, localizations): Improve type safety of localizationKeys() with params
#6108
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
17f0984

wip


panteliselef Jun 12, 2025
7ab2bd9

improve export type names


panteliselef Jun 12, 2025
8b7bf44

make it stricter


panteliselef Jun 12, 2025
d8ff4a8

cleanup


panteliselef Jun 13, 2025
d8e5f31

revert WithParams on top level only


panteliselef Jun 13, 2025
107d27d

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
74ef558

changeset


panteliselef Jun 13, 2025
4116e05

fix lock file


panteliselef Jun 13, 2025
fbe1ede

address todo comments


panteliselef Jun 13, 2025
1cc756e

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
e22a9ce

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
061d302

bump bundle


panteliselef Jun 13, 2025
e4623f1

remove comments


panteliselef Jun 13, 2025
2be8606

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 17, 2025
34dfae4

resolve conflicts


panteliselef Jun 17, 2025
ea97fa8

improve changeset


panteliselef Jun 17, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/cold-turtles-press.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
 onOpen: () => void;
 onClose: () => void;
 apiKeyId?: string;
 apiKeyName?: string;
 apiKeyName: string;
 modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down

14 changes: 6 additions & 8 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
 title: LocalizationKey;
 messageLine1: LocalizationKey;
 messageLine2: LocalizationKey;
 actionDescription?: LocalizationKey;
 actionDescription: LocalizationKey;
 organizationName?: string;
 successMessage: LocalizationKey;
 submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

 const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
 type: 'text',
 label:
 actionDescription ||
 localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
 label: actionDescription,
 isRequired: true,
 placeholder: organizationName,
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('organizationProfile.removeDomainPage.title')}
 messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
 domain: ref.current?.name,
 domain: ref.current?.name || '',
 })}
 messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
 deleteResource={() =>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
 }, [domain?.id]);

 const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
 domain: domain?.name,
 domain: domain?.name || '',
 });
 const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
 domain: domain?.name,
 domain: domain?.name || '',
 });

 const calloutLabel = useCalloutLabel(domain, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
 const subtitleVerificationCodeScreen = localizationKeys(
 'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
 {
 emailAddress: affiliationEmailAddressRef.current,
 emailAddress: affiliationEmailAddressRef.current || '',
 },
 );

Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
 order: ctaPosition === 'top' ? -1 : undefined,
 })}
 >
 {shouldShowFooterNotice ? (
 {shouldShowFooterNotice && subscription ? (
 <Text
 elementDescriptor={descriptors.pricingTableCardFooterNotice}
 variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
 localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
 localizationKey={localizationKeys('badge__startsAt', {
 date: subscription?.periodStart,
 })}
 colorScheme='secondary'
 sx={t => ({
 paddingBlock: t.space.$1x5,
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
 <SignInFactorOneAlternativeChannelCodeForm
 {...props}
 cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
 })}
 cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
 inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

 if (isAlternativePhoneCodeProvider) {
 const provider = getAlternativePhoneCodeProviderData(channel)?.name;
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
 provider: provider || '',
 });
 resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
 }

Expand Down

4 changes: 3 additions & 1 deletion
...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
 <Form.ControlRow elementId='phoneNumber'>
 <Form.PhoneInput
 {...formState.phoneNumber.props}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
 provider: provider || '',
 })}
 isRequired
 isOptional={false}
 actionLabel={undefined}
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
 <FormContainer
 headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
 headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
 identifier: emailAddressRef.current?.emailAddress,
 identifier: emailAddressRef.current?.emailAddress || '',
 })}
 >
 {strategy === 'email_link' && (
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
 <RemoveResourceForm
 title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
 messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
 identifier: providerToDisplayData[ref.current]?.name,
 identifier: providerToDisplayData[ref.current]?.name || '',
 })}
 messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
 successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
 connectedAccount: providerToDisplayData[ref.current]?.name,
 connectedAccount: providerToDisplayData[ref.current]?.name || '',
 })}
 deleteResource={() => Promise.resolve(resource?.destroy())}
 onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
 messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
 name: passkey.name,
 name: passkey.name || '',
 })}
 deleteResource={passkey.delete}
 onSuccess={onSuccess}
Expand Down

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
 <Form.OTPInput
 {...otp}
 label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
 identifier: identifier || '',
 })}
 resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
 centerAlign={false}
 />
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

 if (termsUrl && privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
 termsOfServiceLink: props.termsUrl,
 privacyPolicyLink: props.privacyPolicyUrl,
 termsOfServiceLink: termsUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 } else if (termsUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
 termsOfServiceLink: props.termsUrl,
 termsOfServiceLink: termsUrl,
 });
 } else if (privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
 privacyPolicyLink: props.privacyPolicyUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 }

Expand Down

19 changes: 8 additions & 11 deletions
packages/clerk-js/src/ui/localization/localizationKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
 T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
 key: string;
 params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
 key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
 return { key, params } as LocalizationKey;
 return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.

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
chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 16 commits into

from

Jun 17, 2025
 Merged


chore(clerk-js, localizations): Improve type safety of localizationKeys() with params
#6108
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
17f0984

wip


panteliselef Jun 12, 2025
7ab2bd9

improve export type names


panteliselef Jun 12, 2025
8b7bf44

make it stricter


panteliselef Jun 12, 2025
d8ff4a8

cleanup


panteliselef Jun 13, 2025
d8e5f31

revert WithParams on top level only


panteliselef Jun 13, 2025
107d27d

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
74ef558

changeset


panteliselef Jun 13, 2025
4116e05

fix lock file


panteliselef Jun 13, 2025
fbe1ede

address todo comments


panteliselef Jun 13, 2025
1cc756e

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
e22a9ce

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
061d302

bump bundle


panteliselef Jun 13, 2025
e4623f1

remove comments


panteliselef Jun 13, 2025
2be8606

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 17, 2025
34dfae4

resolve conflicts


panteliselef Jun 17, 2025
ea97fa8

improve changeset


panteliselef Jun 17, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/cold-turtles-press.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
 onOpen: () => void;
 onClose: () => void;
 apiKeyId?: string;
 apiKeyName?: string;
 apiKeyName: string;
 modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down

14 changes: 6 additions & 8 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
 title: LocalizationKey;
 messageLine1: LocalizationKey;
 messageLine2: LocalizationKey;
 actionDescription?: LocalizationKey;
 actionDescription: LocalizationKey;
 organizationName?: string;
 successMessage: LocalizationKey;
 submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

 const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
 type: 'text',
 label:
 actionDescription ||
 localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
 label: actionDescription,
 isRequired: true,
 placeholder: organizationName,
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('organizationProfile.removeDomainPage.title')}
 messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
 domain: ref.current?.name,
 domain: ref.current?.name || '',
 })}
 messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
 deleteResource={() =>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
 }, [domain?.id]);

 const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
 domain: domain?.name,
 domain: domain?.name || '',
 });
 const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
 domain: domain?.name,
 domain: domain?.name || '',
 });

 const calloutLabel = useCalloutLabel(domain, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
 const subtitleVerificationCodeScreen = localizationKeys(
 'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
 {
 emailAddress: affiliationEmailAddressRef.current,
 emailAddress: affiliationEmailAddressRef.current || '',
 },
 );

Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
 order: ctaPosition === 'top' ? -1 : undefined,
 })}
 >
 {shouldShowFooterNotice ? (
 {shouldShowFooterNotice && subscription ? (
 <Text
 elementDescriptor={descriptors.pricingTableCardFooterNotice}
 variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
 localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
 localizationKey={localizationKeys('badge__startsAt', {
 date: subscription?.periodStart,
 })}
 colorScheme='secondary'
 sx={t => ({
 paddingBlock: t.space.$1x5,
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
 <SignInFactorOneAlternativeChannelCodeForm
 {...props}
 cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
 })}
 cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
 inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

 if (isAlternativePhoneCodeProvider) {
 const provider = getAlternativePhoneCodeProviderData(channel)?.name;
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
 provider: provider || '',
 });
 resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
 }

Expand Down

4 changes: 3 additions & 1 deletion
...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
 <Form.ControlRow elementId='phoneNumber'>
 <Form.PhoneInput
 {...formState.phoneNumber.props}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
 provider: provider || '',
 })}
 isRequired
 isOptional={false}
 actionLabel={undefined}
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
 <FormContainer
 headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
 headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
 identifier: emailAddressRef.current?.emailAddress,
 identifier: emailAddressRef.current?.emailAddress || '',
 })}
 >
 {strategy === 'email_link' && (
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
 <RemoveResourceForm
 title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
 messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
 identifier: providerToDisplayData[ref.current]?.name,
 identifier: providerToDisplayData[ref.current]?.name || '',
 })}
 messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
 successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
 connectedAccount: providerToDisplayData[ref.current]?.name,
 connectedAccount: providerToDisplayData[ref.current]?.name || '',
 })}
 deleteResource={() => Promise.resolve(resource?.destroy())}
 onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
 messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
 name: passkey.name,
 name: passkey.name || '',
 })}
 deleteResource={passkey.delete}
 onSuccess={onSuccess}
Expand Down

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
 <Form.OTPInput
 {...otp}
 label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
 identifier: identifier || '',
 })}
 resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
 centerAlign={false}
 />
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

 if (termsUrl && privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
 termsOfServiceLink: props.termsUrl,
 privacyPolicyLink: props.privacyPolicyUrl,
 termsOfServiceLink: termsUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 } else if (termsUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
 termsOfServiceLink: props.termsUrl,
 termsOfServiceLink: termsUrl,
 });
 } else if (privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
 privacyPolicyLink: props.privacyPolicyUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 }

Expand Down

19 changes: 8 additions & 11 deletions
packages/clerk-js/src/ui/localization/localizationKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
 T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
 key: string;
 params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
 key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
 return { key, params } as LocalizationKey;
 return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.

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
chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 16 commits into

from

Jun 17, 2025
 Merged


chore(clerk-js, localizations): Improve type safety of localizationKeys() with params
#6108
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
17f0984

wip


panteliselef Jun 12, 2025
7ab2bd9

improve export type names


panteliselef Jun 12, 2025
8b7bf44

make it stricter


panteliselef Jun 12, 2025
d8ff4a8

cleanup


panteliselef Jun 13, 2025
d8e5f31

revert WithParams on top level only


panteliselef Jun 13, 2025
107d27d

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
74ef558

changeset


panteliselef Jun 13, 2025
4116e05

fix lock file


panteliselef Jun 13, 2025
fbe1ede

address todo comments


panteliselef Jun 13, 2025
1cc756e

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
e22a9ce

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
061d302

bump bundle


panteliselef Jun 13, 2025
e4623f1

remove comments


panteliselef Jun 13, 2025
2be8606

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 17, 2025
34dfae4

resolve conflicts


panteliselef Jun 17, 2025
ea97fa8

improve changeset


panteliselef Jun 17, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/cold-turtles-press.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
 onOpen: () => void;
 onClose: () => void;
 apiKeyId?: string;
 apiKeyName?: string;
 apiKeyName: string;
 modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down

14 changes: 6 additions & 8 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
 title: LocalizationKey;
 messageLine1: LocalizationKey;
 messageLine2: LocalizationKey;
 actionDescription?: LocalizationKey;
 actionDescription: LocalizationKey;
 organizationName?: string;
 successMessage: LocalizationKey;
 submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

 const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
 type: 'text',
 label:
 actionDescription ||
 localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
 label: actionDescription,
 isRequired: true,
 placeholder: organizationName,
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('organizationProfile.removeDomainPage.title')}
 messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
 domain: ref.current?.name,
 domain: ref.current?.name || '',
 })}
 messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
 deleteResource={() =>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
 }, [domain?.id]);

 const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
 domain: domain?.name,
 domain: domain?.name || '',
 });
 const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
 domain: domain?.name,
 domain: domain?.name || '',
 });

 const calloutLabel = useCalloutLabel(domain, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
 const subtitleVerificationCodeScreen = localizationKeys(
 'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
 {
 emailAddress: affiliationEmailAddressRef.current,
 emailAddress: affiliationEmailAddressRef.current || '',
 },
 );

Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
 order: ctaPosition === 'top' ? -1 : undefined,
 })}
 >
 {shouldShowFooterNotice ? (
 {shouldShowFooterNotice && subscription ? (
 <Text
 elementDescriptor={descriptors.pricingTableCardFooterNotice}
 variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
 localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
 localizationKey={localizationKeys('badge__startsAt', {
 date: subscription?.periodStart,
 })}
 colorScheme='secondary'
 sx={t => ({
 paddingBlock: t.space.$1x5,
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
 <SignInFactorOneAlternativeChannelCodeForm
 {...props}
 cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
 })}
 cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
 inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

 if (isAlternativePhoneCodeProvider) {
 const provider = getAlternativePhoneCodeProviderData(channel)?.name;
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
 provider: provider || '',
 });
 resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
 }

Expand Down

4 changes: 3 additions & 1 deletion
...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
 <Form.ControlRow elementId='phoneNumber'>
 <Form.PhoneInput
 {...formState.phoneNumber.props}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
 provider: provider || '',
 })}
 isRequired
 isOptional={false}
 actionLabel={undefined}
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
 <FormContainer
 headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
 headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
 identifier: emailAddressRef.current?.emailAddress,
 identifier: emailAddressRef.current?.emailAddress || '',
 })}
 >
 {strategy === 'email_link' && (
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
 <RemoveResourceForm
 title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
 messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
 identifier: providerToDisplayData[ref.current]?.name,
 identifier: providerToDisplayData[ref.current]?.name || '',
 })}
 messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
 successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
 connectedAccount: providerToDisplayData[ref.current]?.name,
 connectedAccount: providerToDisplayData[ref.current]?.name || '',
 })}
 deleteResource={() => Promise.resolve(resource?.destroy())}
 onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
 messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
 name: passkey.name,
 name: passkey.name || '',
 })}
 deleteResource={passkey.delete}
 onSuccess={onSuccess}
Expand Down

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
 <Form.OTPInput
 {...otp}
 label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
 identifier: identifier || '',
 })}
 resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
 centerAlign={false}
 />
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

 if (termsUrl && privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
 termsOfServiceLink: props.termsUrl,
 privacyPolicyLink: props.privacyPolicyUrl,
 termsOfServiceLink: termsUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 } else if (termsUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
 termsOfServiceLink: props.termsUrl,
 termsOfServiceLink: termsUrl,
 });
 } else if (privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
 privacyPolicyLink: props.privacyPolicyUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 }

Expand Down

19 changes: 8 additions & 11 deletions
packages/clerk-js/src/ui/localization/localizationKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
 T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
 key: string;
 params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
 key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
 return { key, params } as LocalizationKey;
 return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.

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
chore(clerk-js, localizations): Improve type safety of localizationKeys() with params#6108

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.

 Sign up for GitHub

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

 Merged

panteliselef
merged 16 commits into

from

Jun 17, 2025
 Merged


chore(clerk-js, localizations): Improve type safety of localizationKeys() with params
#6108
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
17f0984

wip


panteliselef Jun 12, 2025
7ab2bd9

improve export type names


panteliselef Jun 12, 2025
8b7bf44

make it stricter


panteliselef Jun 12, 2025
d8ff4a8

cleanup


panteliselef Jun 13, 2025
d8e5f31

revert WithParams on top level only


panteliselef Jun 13, 2025
107d27d

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
74ef558

changeset


panteliselef Jun 13, 2025
4116e05

fix lock file


panteliselef Jun 13, 2025
fbe1ede

address todo comments


panteliselef Jun 13, 2025
1cc756e

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
e22a9ce

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 13, 2025
061d302

bump bundle


panteliselef Jun 13, 2025
e4623f1

remove comments


panteliselef Jun 13, 2025
2be8606

Merge branch 'main' into elef/improve-localization-keys-dx


panteliselef Jun 17, 2025
34dfae4

resolve conflicts


panteliselef Jun 17, 2025
ea97fa8

improve changeset


panteliselef Jun 17, 2025

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


5 changes: 5 additions & 0 deletions
.changeset/cold-turtles-press.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/types': minor
---

Expose `__internal_LocalizationResource` which now includes metadata for which keys require interpolation.

2 changes: 1 addition & 1 deletion
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@
 { "path": "./dist/clerk.browser.js", "maxSize": "70.16KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "113KB" },
 { "path": "./dist/clerk.headless*.js", "maxSize": "53.06KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.36KB" },
 { "path": "./dist/ui-common*.js", "maxSize": "108.4KB" },
 { "path": "./dist/vendors*.js", "maxSize": "40.2KB" },
 { "path": "./dist/coinbase*.js", "maxSize": "38KB" },
 { "path": "./dist/createorganization*.js", "maxSize": "5KB" },
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/ApiKeys/RevokeAPIKeyConfirmationModal.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ type RevokeAPIKeyConfirmationModalProps = {
 onOpen: () => void;
 onClose: () => void;
 apiKeyId?: string;
 apiKeyName?: string;
 apiKeyName: string;
 modalRoot?: React.MutableRefObject<HTMLElement | null>;
};

Expand Down

14 changes: 6 additions & 8 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActionConfirmationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -49,13 +49,13 @@ export const LeaveOrganizationForm = (props: LeaveOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -79,13 +79,13 @@ export const DeleteOrganizationForm = (props: DeleteOrganizationFormProps) => {

 return (
 <ActionConfirmationPage
 organizationName={organization?.name}
 organizationName={organization.name}
 title={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 messageLine1={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine1')}
 messageLine2={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.messageLine2')}
 actionDescription={localizationKeys(
 'organizationProfile.profilePage.dangerSection.deleteOrganization.actionDescription',
 { organizationName: organization?.name },
 { organizationName: organization.name },
 )}
 submitLabel={localizationKeys('organizationProfile.profilePage.dangerSection.deleteOrganization.title')}
 successMessage={localizationKeys(
Expand All@@ -101,7 +101,7 @@ type ActionConfirmationPageProps = FormProps & {
 title: LocalizationKey;
 messageLine1: LocalizationKey;
 messageLine2: LocalizationKey;
 actionDescription?: LocalizationKey;
 actionDescription: LocalizationKey;
 organizationName?: string;
 successMessage: LocalizationKey;
 submitLabel: LocalizationKey;
Expand All@@ -128,9 +128,7 @@ const ActionConfirmationPage = withCardStateProvider((props: ActionConfirmationP

 const confirmationField = useFormControl('deleteOrganizationConfirmation', '', {
 type: 'text',
 label:
 actionDescription ||
 localizationKeys('organizationProfile.profilePage.dangerSection.leaveOrganization.actionDescription'),
 label: actionDescription,
 isRequired: true,
 placeholder: organizationName,
 });
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/RemoveDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,7 +62,7 @@ export const RemoveDomainForm = (props: RemoveDomainFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('organizationProfile.removeDomainPage.title')}
 messageLine1={localizationKeys('organizationProfile.removeDomainPage.messageLine1', {
 domain: ref.current?.name,
 domain: ref.current?.name || '',
 })}
 messageLine2={localizationKeys('organizationProfile.removeDomainPage.messageLine2')}
 deleteResource={() =>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/VerifiedDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -129,10 +129,10 @@ export const VerifiedDomainForm = withCardStateProvider((props: VerifiedDomainFo
 }, [domain?.id]);

 const title = localizationKeys('organizationProfile.verifiedDomainPage.title', {
 domain: domain?.name,
 domain: domain?.name || '',
 });
 const subtitle = localizationKeys('organizationProfile.verifiedDomainPage.subtitle', {
 domain: domain?.name,
 domain: domain?.name || '',
 });

 const calloutLabel = useCalloutLabel(domain, {
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/OrganizationProfile/VerifyDomainForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,7 +50,7 @@ export const VerifyDomainForm = withCardStateProvider((props: VerifyDomainFormPr
 const subtitleVerificationCodeScreen = localizationKeys(
 'organizationProfile.verifyDomainPage.subtitleVerificationCodeScreen',
 {
 emailAddress: affiliationEmailAddressRef.current,
 emailAddress: affiliationEmailAddressRef.current || '',
 },
 );

Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/PricingTable/PricingTableDefault.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -247,11 +247,13 @@ function Card(props: CardProps) {
 order: ctaPosition === 'top' ? -1 : undefined,
 })}
 >
 {shouldShowFooterNotice ? (
 {shouldShowFooterNotice && subscription ? (
 <Text
 elementDescriptor={descriptors.pricingTableCardFooterNotice}
 variant={isCompact ? 'buttonSmall' : 'buttonLarge'}
 localizationKey={localizationKeys('badge__startsAt', { date: subscription?.periodStart })}
 localizationKey={localizationKeys('badge__startsAt', {
 date: subscription?.periodStart,
 })}
 colorScheme='secondary'
 sx={t => ({
 paddingBlock: t.space.$1x5,
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/SignIn/SignInFactorOneAlternativePhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ export const SignInFactorOneAlternativePhoneCodeCard = (props: SignInFactorOneAl
 <SignInFactorOneAlternativeChannelCodeForm
 {...props}
 cardTitle={localizationKeys('signIn.alternativePhoneCodeProvider.title', {
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name,
 provider: getAlternativePhoneCodeProviderData(props.factor.channel)?.name || '',
 })}
 cardSubtitle={localizationKeys('signIn.alternativePhoneCodeProvider.subtitle')}
 inputLabel={localizationKeys('signIn.alternativePhoneCodeProvider.formTitle')}
Expand Down

6 changes: 4 additions & 2 deletions
packages/clerk-js/src/ui/components/SignUp/SignUpPhoneCodeCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -58,8 +58,10 @@ export const SignUpPhoneCodeCard = withCardStateProvider(() => {

 if (isAlternativePhoneCodeProvider) {
 const provider = getAlternativePhoneCodeProviderData(channel)?.name;
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', { provider });
 cardTitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.title', { provider: provider || '' });
 cardSubtitleKey = localizationKeys('signUp.alternativePhoneCodeProvider.subtitle', {
 provider: provider || '',
 });
 resendButtonKey = localizationKeys('signUp.alternativePhoneCodeProvider.resendButton');
 }

Expand Down

4 changes: 3 additions & 1 deletion
...ages/clerk-js/src/ui/components/SignUp/SignUpStartAlternativePhoneCodePhoneNumberCard.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -75,7 +75,9 @@ export const SignUpStartAlternativePhoneCodePhoneNumberCard = (props: SignUpForm
 <Form.ControlRow elementId='phoneNumber'>
 <Form.PhoneInput
 {...formState.phoneNumber.props}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', { provider })}
 label={localizationKeys('signUp.start.alternativePhoneCodeProvider.label', {
 provider: provider || '',
 })}
 isRequired
 isOptional={false}
 actionLabel={undefined}
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/EmailForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -86,7 +86,7 @@ export const EmailForm = withCardStateProvider((props: EmailFormProps) => {
 <FormContainer
 headerTitle={localizationKeys('userProfile.emailAddressPage.verifyTitle')}
 headerSubtitle={localizationKeys(`${translationKey}.formSubtitle`, {
 identifier: emailAddressRef.current?.emailAddress,
 identifier: emailAddressRef.current?.emailAddress || '',
 })}
 >
 {strategy === 'email_link' && (
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/MfaPhoneCodeScreen.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -151,7 +151,7 @@ export const MFAVerifyPhone = (props: MFAVerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

2 changes: 1 addition & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/PhoneForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ export const VerifyPhone = (props: VerifyPhoneProps) => {
 <FormContainer
 headerTitle={title}
 headerSubtitle={localizationKeys('userProfile.phoneNumberPage.verifySubtitle', {
 identifier: resourceRef.current?.phoneNumber,
 identifier: resourceRef.current?.phoneNumber || '',
 })}
 >
 <VerifyWithCode
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/components/UserProfile/RemoveResourceForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -100,11 +100,11 @@ export const RemoveConnectedAccountForm = (props: ConnectedAccountFormProps) =>
 <RemoveResourceForm
 title={localizationKeys('userProfile.connectedAccountPage.removeResource.title')}
 messageLine1={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine1', {
 identifier: providerToDisplayData[ref.current]?.name,
 identifier: providerToDisplayData[ref.current]?.name || '',
 })}
 messageLine2={localizationKeys('userProfile.connectedAccountPage.removeResource.messageLine2')}
 successMessage={localizationKeys('userProfile.connectedAccountPage.removeResource.successMessage', {
 connectedAccount: providerToDisplayData[ref.current]?.name,
 connectedAccount: providerToDisplayData[ref.current]?.name || '',
 })}
 deleteResource={() => Promise.resolve(resource?.destroy())}
 onSuccess={onSuccess}
Expand DownExpand Up@@ -212,7 +212,7 @@ export const RemovePasskeyForm = (props: RemovePasskeyFormProps) => {
 <RemoveResourceForm
 title={localizationKeys('userProfile.passkeyScreen.removeResource.title')}
 messageLine1={localizationKeys('userProfile.passkeyScreen.removeResource.messageLine1', {
 name: passkey.name,
 name: passkey.name || '',
 })}
 deleteResource={passkey.delete}
 onSuccess={onSuccess}
Expand Down

4 changes: 3 additions & 1 deletion
packages/clerk-js/src/ui/components/UserProfile/VerifyWithCode.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -45,7 +45,9 @@ export const VerifyWithCode = (props: VerifyWithCodeProps) => {
 <Form.OTPInput
 {...otp}
 label={localizationKeys('userProfile.emailAddressPage.emailCode.formTitle')}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', { identifier })}
 description={localizationKeys('userProfile.emailAddressPage.emailCode.formSubtitle', {
 identifier: identifier || '',
 })}
 resendButton={localizationKeys('userProfile.emailAddressPage.emailCode.resendButton')}
 centerAlign={false}
 />
Expand Down

8 changes: 4 additions & 4 deletions
packages/clerk-js/src/ui/elements/LegalConsentCheckbox.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -23,16 +23,16 @@ const LegalCheckboxLabel = (props: { termsUrl?: string; privacyPolicyUrl?: strin

 if (termsUrl && privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__termsOfServiceAndPrivacyPolicy', {
 termsOfServiceLink: props.termsUrl,
 privacyPolicyLink: props.privacyPolicyUrl,
 termsOfServiceLink: termsUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 } else if (termsUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyTermsOfService', {
 termsOfServiceLink: props.termsUrl,
 termsOfServiceLink: termsUrl,
 });
 } else if (privacyPolicyUrl) {
 localizationKey = localizationKeys('signUp.legalConsent.checkbox.label__onlyPrivacyPolicy', {
 privacyPolicyLink: props.privacyPolicyUrl,
 privacyPolicyLink: privacyPolicyUrl,
 });
 }

Expand Down

19 changes: 8 additions & 11 deletions
packages/clerk-js/src/ui/localization/localizationKeys.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
import type { PathValue, RecordToPath } from '@clerk/types';

import type { defaultResource } from './defaultEnglishResource';
import type { __internal_LocalizationResource, PathValue, RecordToPath } from '@clerk/types';

type Value = string | number | boolean | Date;
type Whitespace = ' ' | '\t' | '\n' | '\r';
Expand DownExpand Up@@ -61,20 +59,19 @@ export type GetICUArgs<Text extends string, T extends RemovePipeUtils<Text>> = T
 T extends readonly string[] ? TupleFindBlocks<T> : FindBlocks<T>
>;

type DefaultLocalizationKey = RecordToPath<typeof defaultResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<typeof defaultResource, P>;

// @ts-ignore
type LocalizationKeyToParams<P extends DefaultLocalizationKey> = GetICUArgs<LocalizationKeyToValue<P>>;
type DefaultLocalizationKey = RecordToPath<__internal_LocalizationResource>;
type LocalizationKeyToValue<P extends DefaultLocalizationKey> = PathValue<__internal_LocalizationResource, P>;

export type LocalizationKey = {
 key: string;
 params: Record<string, any> | undefined;
};

export const localizationKeys = <Key extends DefaultLocalizationKey, Params extends LocalizationKeyToParams<Key>>(
type ExtractArgsFromValue<Value> = Value extends { __params: any } ? [params: Value['__params']] : [];

export const localizationKeys = <Key extends DefaultLocalizationKey, Value extends LocalizationKeyToValue<Key>>(
 key: Key,
params?: keyof Params extends never ? never : Params,
...args: ExtractArgsFromValue<Value>
): LocalizationKey => {
 return { key, params } as LocalizationKey;
 return { key, params: args[0] } as LocalizationKey;
};
Comment thread
panteliselef marked this conversation as resolved.

Loading