Skip to content

A full-featured CRM built with React, shadcn/ui, and Supabase.

Type-check CRM message catalogs and document strict/partial usage

Anibal Svarcasa750bdf43f00
diff --git a/doc/src/content/docs/developers/customizing.mdx b/doc/src/content/docs/developers/customizing.mdx
index a8ebdc29..2ac6091a 100644
--- a/doc/src/content/docs/developers/customizing.mdx
+++ b/doc/src/content/docs/developers/customizing.mdx
@@ -107,6 +107,37 @@ Edit `src/components/atomic-crm/root/i18nProvider.tsx` and update:
4. Add app-specific keys (for example in a `crm.*` namespace) when needed.
5. Start the app, switch locale from the user menu, and verify fallback behavior.
+### Type-Check Message Catalogs
+
+For in-repo locales (like `fr`), use strict typing so missing keys fail at compile time:
+
+```ts
+import type { CrmMessages } from './englishCrmMessages';
+
+export const frenchCrmMessages = {
+ crm: {
+ // ...
+ },
+} satisfies CrmMessages;
+```
+
+For external/custom locales, you can choose either approach:
+
+- strict typing (`CrmMessages`) if you want a complete catalog
+- partial typing (`PartialCrmMessages`) if you prefer incremental translations with English fallback
+
+Example with partial typing:
+
+```ts
+import type { PartialCrmMessages } from './englishCrmMessages';
+
+const polishMessages: PartialCrmMessages = {
+ crm: {
+ // only override what you need
+ },
+};
+```
+
If an official package does not exist for a given integration (for example `ra-supabase-language-<locale>`), keep English integration messages as the base and override only the keys you need for your locale.
## Disabling Telemetry
diff --git a/src/components/atomic-crm/root/englishCrmMessages.ts b/src/components/atomic-crm/root/englishCrmMessages.ts
index c00a1b69..b068abd6 100644
--- a/src/components/atomic-crm/root/englishCrmMessages.ts
+++ b/src/components/atomic-crm/root/englishCrmMessages.ts
@@ -538,3 +538,20 @@ export const englishCrmMessages = {
},
},
} as const;
+
+type MessageSchema<T> = {
+ [K in keyof T]: T[K] extends string
+ ? string
+ : T[K] extends Record<string, unknown>
+ ? MessageSchema<T[K]>
+ : never;
+};
+
+type DeepPartial<T> = {
+ [K in keyof T]?: T[K] extends Record<string, unknown>
+ ? DeepPartial<T[K]>
+ : T[K];
+};
+
+export type CrmMessages = MessageSchema<typeof englishCrmMessages>;
+export type PartialCrmMessages = DeepPartial<CrmMessages>;
diff --git a/src/components/atomic-crm/root/frenchCrmMessages.ts b/src/components/atomic-crm/root/frenchCrmMessages.ts
index dca2e07b..31535d83 100644
--- a/src/components/atomic-crm/root/frenchCrmMessages.ts
+++ b/src/components/atomic-crm/root/frenchCrmMessages.ts
@@ -1,3 +1,5 @@
+import type { CrmMessages } from "./englishCrmMessages";
+
export const frenchCrmMessages = {
crm: {
auth: {
@@ -542,4 +544,4 @@ export const frenchCrmMessages = {
invalid_linkedin_url: "L'URL doit provenir de linkedin.com",
},
},
-} as const;
+} satisfies CrmMessages;