Implement custom routing mode

[aymericzip]

Some users asked to localize the urls

We actually offer different modes : 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'

Doc: https://intlayer.org/doc/concept/configuration#routing-configuration

We you like to add an additional mode: 'custom-routes'

Wanted behavior:
instead of /en/about x /fr/about, getting /about x /a-propos

It should be implemented on both nextjs and vite proxies

packages/next-intlayer/src/proxy/intlayerProxy.ts

packages/vite-intlayer/src/intlayerProxyPlugin.ts

It should rewrite the url only, without redirection

[aymericzip]

@HowWhat42

We will have to design the behavior,

Here're some question marks:

• what if we are missing declaring one route, or one locale for one route ? will we fallback to prefix-no-default ? prefix-all ?
• How do we handle dynamic routes ?

Example of implementation : (naming can change)

import {
  type IntlayerConfig,
  type Locale,
  Locales,
} from 'intlayer';

const config: IntlayerConfig = {
  internationalization: {
    locales: [
     Locales.ENGLISH,
     Locales.FRENCH,
     Locales.SPANISH,
   ],
    defaultLocale: Locales.ENGLISH,
  },
  routing: {
    mode: 'custom-routes',
    customRoutes: {
      // Key is the path without the locale prefix
      '/': {
        en: '/',
        fr: '/fr',
        es: '/es',
      },
      '/about': {
        fr: 'a-propos',
        es: 'acerca-de',
      },
      // What happens if we do not declare one existing route ?
      // '/privacy-notice': {
      //   en: '/privacy-notice',
      //   fr: '/fr/avis-de-confidentialite',
      //   es: '/es/aviso-de-privacidad',
      // },
      '/home': {
        en: '/en/home',
        fr: '/fr/accueil',
        // es: "/es/inicio", // What happens if the locale is not declared ?
      },
      // How do we handle dynamic routes ?
      'user/1234567890': {
        en: '/en/user/1234567890',
        fr: '/fr/utilisateur/1234567890',
        es: '/es/usuario/1234567890',
      },
    },
  },
};

export default config;

We may have to consider the approach of next-intl
https://www.reddit.com/r/nextjs/comments/1it22c1/how_to_translate_routes_in_nextjs_15_with_the_new/

[HowWhat42]

I was more thinking something like that

about: route({
      en: '/about',
      fr: '/a-propos',
      es: '/acerca-de',
})

Like with a new function to register a custom route.

If we are missing a translation, we should probably fallback to prefix-no-default as it is the default of the package.
About dynamic routes we could use the syntax of Next or Vite :

   {
     "blog/[slug]": {
       nodeType: "route",
       routes: {
         en: "/blog/[slug]",
         fr: "/blogue/[slug]"
       }
     }
   }