fix(localizations,types): Add types for form_param_type_invalid errors #6457

dstaley · 2025-08-01T16:45:59Z

Description

This PR adds types for form_param_type_invalid error messages to our localizations.

Checklist

pnpm test runs as expected.
pnpm build runs as expected.
(If applicable) JSDoc comments have been added or updated for any package exports
(If applicable) Documentation has been updated

Type of change

Summary by CodeRabbit

New Features
- Added new error message keys for invalid form parameter types, including specific cases for phone numbers and email addresses, across multiple localization resources.
Documentation
- Updated type definitions to include the new form parameter type validation errors for improved clarity in error handling.

changeset-bot · 2025-08-01T16:46:03Z

🦋 Changeset detected

Latest commit: aee424f

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 22 packages

Name	Type
@clerk/localizations	Patch
@clerk/types	Patch
@clerk/clerk-js	Patch
@clerk/clerk-react	Patch
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/backend	Patch
@clerk/elements	Patch
@clerk/expo-passkeys	Patch
@clerk/clerk-expo	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/shared	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch
@clerk/themes	Patch
@clerk/vue	Patch
@clerk/chrome-extension	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

vercel · 2025-08-01T16:46:04Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 1, 2025 5:12pm

coderabbitai · 2025-08-01T16:49:40Z

📝 Walkthrough

Walkthrough

This change adds new type declarations for form_param_type_invalid errors in the @clerk/types package and introduces corresponding localization keys in the @clerk/localizations package. Specifically, three new error keys—form_param_type_invalid, form_param_type_invalid__phone_number, and form_param_type_invalid__email_address—are added to the English localization resource and type definitions. Additionally, these three keys are added with undefined values to the unstable__errors section across numerous localization files for various languages, expanding the set of form parameter validation error keys without modifying existing keys or values.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-08-01T16:50:09Z

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6457

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@6457

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@6457

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@6457

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@6457

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6457

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6457

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@6457

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@6457

@clerk/express

npm i https://pkg.pr.new/@clerk/express@6457

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@6457

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@6457

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@6457

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@6457

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@6457

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@6457

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6457

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@6457

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@6457

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@6457

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6457

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6457

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@6457

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@6457

commit: aee424f

alexcarpenter

I think with the additions, we need to run the generate function to update all locales with the new params right?

alexcarpenter · 2025-08-01T17:01:23Z

packages/localizations/src/en-US.ts

+    form_param_type_invalid: undefined,
+    form_param_type_invalid__phone_number: undefined,
+    form_param_type_invalid__email_address: undefined,


are these different then the ones directly above. did we migrate from format to type?

FAPI has both!

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (5)

packages/localizations/src/it-IT.ts (1)
817-819: LGTM! New error keys added consistently.

The three new form_param_type_invalid error keys are properly placed within the unstable__errors section and follow the established naming conventions. The undefined values are consistent with the pattern used for other untranslated keys in this file.

However, consider adding Italian translations for these keys to provide a complete localization experience:
-    form_param_type_invalid: undefined,
-    form_param_type_invalid__email_address: undefined,
-    form_param_type_invalid__phone_number: undefined,
+    form_param_type_invalid: 'Tipo di parametro non valido.',
+    form_param_type_invalid__email_address: 'Il tipo di indirizzo email non è valido.',
+    form_param_type_invalid__phone_number: 'Il tipo di numero di telefono non è valido.',
packages/localizations/src/bg-BG.ts (1)

807-809: LGTM! Consistent implementation across localization files.

The new form parameter type validation error keys are correctly implemented, maintaining consistency with other localization files in the PR. The undefined values are appropriate for community-contributed localization files.

Consider adding tests for the new error keys.

Since no tests were added or modified as part of this PR, consider adding tests to verify that the new form_param_type_invalid error keys are properly typed and accessible in the localization system.
packages/localizations/src/fr-FR.ts (1)
819-821: LGTM! Placeholder entries added correctly for new form validation errors.

The three new form_param_type_invalid error keys have been properly added to the unstable__errors section with undefined values, which is consistent with the pattern used throughout this localization file for untranslated strings.

However, consider providing French translations for these new error keys to improve the user experience for French-speaking users:
-    form_param_type_invalid: undefined,
-    form_param_type_invalid__email_address: undefined,
-    form_param_type_invalid__phone_number: undefined,
+    form_param_type_invalid: 'Le type de paramètre est invalide.',
+    form_param_type_invalid__email_address: 'Le type de paramètre pour l\'adresse e-mail est invalide.',
+    form_param_type_invalid__phone_number: 'Le type de paramètre pour le numéro de téléphone est invalide.',
packages/localizations/src/es-CR.ts (1)

816-818: LGTM! Consistent addition of new form validation error keys.

The addition of the three new form_param_type_invalid error keys with undefined values is consistent with the broader coordinated effort described in the PR objectives. This establishes the proper structure for future Spanish (Costa Rica) translations of these form parameter type validation errors.

Consider adding actual Spanish translations for these keys in a follow-up PR to provide localized error messages for Costa Rican users.

packages/localizations/src/be-BY.ts (1)

815-817: LGTM! Proper addition of form validation error keys.

The three new form_param_type_invalid error keys are correctly added with undefined values, maintaining consistency with the coordinated localization update across all language files. This establishes the foundation for future Belarusian translations.

Since this file already has comprehensive Belarusian translations for similar error keys (e.g., form_param_format_invalid__email_address on line 808-810), consider adding Belarusian translations for these new keys in a subsequent update.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 84d2de1 and aee424f.

📒 Files selected for processing (49)

packages/localizations/src/ar-SA.ts (1 hunks)
packages/localizations/src/be-BY.ts (1 hunks)
packages/localizations/src/bg-BG.ts (1 hunks)
packages/localizations/src/bn-IN.ts (1 hunks)
packages/localizations/src/ca-ES.ts (1 hunks)
packages/localizations/src/cs-CZ.ts (1 hunks)
packages/localizations/src/da-DK.ts (1 hunks)
packages/localizations/src/de-DE.ts (1 hunks)
packages/localizations/src/el-GR.ts (1 hunks)
packages/localizations/src/en-GB.ts (1 hunks)
packages/localizations/src/en-US.ts (1 hunks)
packages/localizations/src/es-CR.ts (1 hunks)
packages/localizations/src/es-ES.ts (1 hunks)
packages/localizations/src/es-MX.ts (1 hunks)
packages/localizations/src/es-UY.ts (1 hunks)
packages/localizations/src/fa-IR.ts (1 hunks)
packages/localizations/src/fi-FI.ts (1 hunks)
packages/localizations/src/fr-FR.ts (1 hunks)
packages/localizations/src/he-IL.ts (1 hunks)
packages/localizations/src/hi-IN.ts (1 hunks)
packages/localizations/src/hr-HR.ts (1 hunks)
packages/localizations/src/hu-HU.ts (1 hunks)
packages/localizations/src/id-ID.ts (1 hunks)
packages/localizations/src/is-IS.ts (1 hunks)
packages/localizations/src/it-IT.ts (1 hunks)
packages/localizations/src/ja-JP.ts (1 hunks)
packages/localizations/src/kk-KZ.ts (1 hunks)
packages/localizations/src/ko-KR.ts (1 hunks)
packages/localizations/src/mn-MN.ts (1 hunks)
packages/localizations/src/ms-MY.ts (1 hunks)
packages/localizations/src/nb-NO.ts (1 hunks)
packages/localizations/src/nl-BE.ts (1 hunks)
packages/localizations/src/nl-NL.ts (1 hunks)
packages/localizations/src/pl-PL.ts (1 hunks)
packages/localizations/src/pt-BR.ts (1 hunks)
packages/localizations/src/pt-PT.ts (1 hunks)
packages/localizations/src/ro-RO.ts (1 hunks)
packages/localizations/src/ru-RU.ts (1 hunks)
packages/localizations/src/sk-SK.ts (1 hunks)
packages/localizations/src/sr-RS.ts (1 hunks)
packages/localizations/src/sv-SE.ts (1 hunks)
packages/localizations/src/ta-IN.ts (1 hunks)
packages/localizations/src/te-IN.ts (1 hunks)
packages/localizations/src/th-TH.ts (1 hunks)
packages/localizations/src/tr-TR.ts (1 hunks)
packages/localizations/src/uk-UA.ts (1 hunks)
packages/localizations/src/vi-VN.ts (1 hunks)
packages/localizations/src/zh-CN.ts (1 hunks)
packages/localizations/src/zh-TW.ts (1 hunks)

✅ Files skipped from review due to trivial changes (27)

packages/localizations/src/nl-NL.ts
packages/localizations/src/sk-SK.ts
packages/localizations/src/he-IL.ts
packages/localizations/src/es-MX.ts
packages/localizations/src/ro-RO.ts
packages/localizations/src/de-DE.ts
packages/localizations/src/es-ES.ts
packages/localizations/src/mn-MN.ts
packages/localizations/src/en-GB.ts
packages/localizations/src/ta-IN.ts
packages/localizations/src/ar-SA.ts
packages/localizations/src/vi-VN.ts
packages/localizations/src/hr-HR.ts
packages/localizations/src/fa-IR.ts
packages/localizations/src/bn-IN.ts
packages/localizations/src/ko-KR.ts
packages/localizations/src/ms-MY.ts
packages/localizations/src/pt-BR.ts
packages/localizations/src/pt-PT.ts
packages/localizations/src/zh-CN.ts
packages/localizations/src/el-GR.ts
packages/localizations/src/tr-TR.ts
packages/localizations/src/uk-UA.ts
packages/localizations/src/zh-TW.ts
packages/localizations/src/th-TH.ts
packages/localizations/src/nl-BE.ts
packages/localizations/src/ru-RU.ts

🚧 Files skipped from review as they are similar to previous changes (1)

packages/localizations/src/en-US.ts

🧰 Additional context used

📓 Path-based instructions (9)

**/*.{js,jsx,ts,tsx}