☂️ Umbrella: List of potential features / changes for a major version

[amannn]

This is a list of ideas for API changes that we could potentially introduce in a major version:

• Improve initial render of Link for localePrefix: 'as-necessary' and make getPathname more useful #444
• Maybe we could automatically forward formats to Client Components with an option to opt-out (formats={null}). Keep in mind: fix: Don't retrieve defaults for locale, now and timeZone if these options have been provided to NextIntlClientProvider #633. See previously proposed docs changes in 80332fc.
• Return typed messages from useMessages? Consider that only a subset of the existing messages might be returned though.
• Add IntlFormats for strict typing of formats
• It's strongly encouraged to render NextIntlClientProvider from a Server Component, as we can automatically inherit config there. Do we need better error handling if the user renders this component from a Client Component? There are still valid use cases for this, e.g. for unit testing / Storybook.
• Add validation in plugin that no trailing slashes config is supported
• Add an API to define routing config in central place (e.g. defineRouting)?
• Replace createSharedPathnamesNavigation and createLocalizedPathnamesNavigation with a single factory function? Support for pathnames only accounts for 0.28 kB and we could provide an easier getting started experience by only offering one. We need to check if overloading for both use cases works as expected though.
• Use /${string} for stricter typing of pathnames instead of string

No decision has been made on these so far, but if you have feedback about these points, please leave it here!

[amannn]

Adding the prefix for getPathname was also discussed in #785 (reply in thread).

[vricop]

Return typed messages from useMessages would be really nice.

Does anyone know a workaround for this?

[vricop]

Return typed messages from useMessages would be really nice.

Does anyone know a workaround for this?

I find out how to properly type safe the useMessages hook temporarily.

We can overload the function in our ./global.d.ts types like this:

import en from 'messages/en.json'

export type Messages = typeof en

declare module 'next-intl' {
  interface IntlMessages extends Messages {}
  
  function useMessages(): IntlMessages;
}

[vricop]

Return typed messages from useMessages would be really nice.
Does anyone know a workaround for this?

I find out how to properly type safe the useMessages hook temporarily.

We can overload the function in our ./global.d.ts types like this:

import en from 'messages/en.json'

export type Messages = typeof en

declare module 'next-intl' {
  interface IntlMessages extends Messages {}
  
  function useMessages(): IntlMessages;
}

⚠️🚨 DON'T DO THIS. I FIND OUT IT BREAKS t() TYPE SAFETY ⚠️🚨

After trying many things I ended using type assertion with as:

 const t = useTranslations()
 const message = useMessages() as unknown as Messages

Not ideal, but at least there's a workaround.