feat!: typed i18n

[AlessioGr]

Description

BREAKING: all i18n functions are now strongly typed, which will create errors if you have custom translations. If you do, you will have to pass a generic to i18n containing the types of your custom translations

Example of adding your own translations to the default translations type on the client:

const linkTranslations = {
  en: {
    lexical: {
      link: {
        custom: 'Custom',
        internal: 'Internal',
      },
    },
  },
}

type LinkTranslationKeys = NestedKeysStripped<typeof linkTranslations.en>

type MyI18n = I18nClient<typeof linkTranslations.en, LinkTranslationKeys>

const myI18n: MyI18n

myI18n.t('lexical:link:custom') // custom translations have been ADDED to the default client translations

Example for the useTranslation hook within a component:

const linkTranslations = {
  en: {
    lexical: {
      link: {
        custom: 'Custom',
        internal: 'Internal',
      },
    },
  },
}

type LinkTranslationKeys = NestedKeysStripped<typeof linkTranslations.en>

export const MyComponent: React.FC = () => {
  const { i18n, t } = useTranslation<typeof linkTranslations.en, LinkTranslationKeys>()

  return t('lexical:link:custom')
}

• I have read and understand the CONTRIBUTING.md document in this repository.

Type of change

• Chore (non-breaking change which does not add functionality)
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Change to the templates directory (does not affect core functionality)
• Change to the examples directory (does not affect core functionality)
• This change requires a documentation update

Checklist:

• I have added tests that prove my fix is effective or that my feature works
• Existing test suite passes locally with my changes
• I have made corresponding changes to the documentation

[denolfe]

Let's be sure to regenerate the keys in a subsequent PR in order to remove the @ts-nocheck comments.