refactor(nuxt-module): added autoChangeCookie option to nuxt config (vuestorefront#6595)

* refactor(nuxt-module): added `autoChangeCookie` option to nuxt config

This enables the possibility to control how the i18n plugin handles the cookies, so integrators can also control more finite the cookies without the plugin handling for then.

* docs: added PR changelog file

Author: bloodf

packages/core/docs/changelog/6595.js

@@ -0,0 +1,8 @@
+module.exports = {
+  description: 'Add the `autoChangeCookie` option on nuxt-i18n configuration to handle fine control on cookie',
+  link: '',
+  isBreaking: false,
+  breakingChanges: [],
+  author: 'Heitor Ramon',
+  linkToGitHubAccount: 'https://github.com/bloodf'
+};

packages/core/docs/getting-started/internationalization.md

@@ -84,3 +84,44 @@ You can provide your own i18n configuration just for a specific module by settin
   },
 ];
 ```
+
+## Configuring the Auto Cookie Change
+You can control how the `@vue-storefront/nuxt` module will handle the cookies under the hood. This configuration will allow you to manage the fine control on the cookie changes after each locale changes.
+
+The `autoChangeCookie` object holds three new properties, that are direct linked to `currency`, `locale`, and `country`. Those properties control how the module will handle the cookie changes. If set to `false`, the module won't change automatically any cookie based on configurations or browser locale, so the `{INTEGARTION}` will handle that.
+
+```js
+// nuxt.config.js
+modules: [
+  ['@vue-storefront/{INTEGRATION}/nuxt', {
+    api: {
+      // api client configuration
+    },
+    i18n: {
+      useNuxtI18nModule: true
+    }
+  }]
+],
+  i18n: {
+  locales: [
+    {
+      code: 'en',
+      label: 'English',
+      file: 'en.js',
+      iso: 'en'
+    },
+    {
+      code: 'de',
+      label: 'German',
+      file: 'de.js',
+      iso: 'de'
+    }
+  ],
+    defaultLocale: 'en',
+    autoChangeCookie: {
+    currency: false,
+      locale: false,
+      country: false,
+  },
+}
+```

packages/core/nuxt-module/lib/plugins/i18n-cookies.js

@@ -13,6 +13,13 @@ const i18nCookiesPlugin = ({ $cookies, i18n, app, redirect }) => {
   }
   const cookieLocale = $cookies.get(cookieNames.locale);
   const cookieCurrency = $cookies.get(cookieNames.currency);
+  const cookieCountry = $cookies.get(cookieNames.country);
+  const autoChangeCookie = {
+    locale: true,
+    currency: true,
+    country: true,
+    ...i18nOptions.autoChangeCookie,
+  };
 
   const getCurrencyByLocale = (locale) =>
     i18n.numberFormats?.[locale]?.currency?.currency
@@ -70,19 +77,27 @@ const i18nCookiesPlugin = ({ $cookies, i18n, app, redirect }) => {
     throw new Error(`Following fields are missing in the i18n configuration: ${missingFields.join(', ')}`);
   }
 
-  if (cookieLocale !== settings.locale) {
+  if ((cookieLocale !== settings.locale && autoChangeCookie.locale) || !cookieLocale) {
     $cookies.set(cookieNames.locale, settings.locale, cookieOptions);
   }
 
-  if (cookieCurrency !== settings.currency) {
+  if ((cookieCurrency !== settings.currency && autoChangeCookie.currency) || !cookieCurrency) {
     $cookies.set(cookieNames.currency, settings.currency, cookieOptions);
   }
 
-  !$cookies.get(cookieNames.country) && $cookies.set(cookieNames.country, settings.country, cookieOptions);
+  if ((cookieCountry !== settings.country && autoChangeCookie.country) || !cookieCountry) {
+    $cookies.set(cookieNames.country, settings.country, cookieOptions);
+  }
 
   i18n.onBeforeLanguageSwitch = (oldLocale, newLocale, isInitialSetup, context) => {
-    $cookies.set(cookieNames.locale, newLocale, cookieOptions);
-    $cookies.set(cookieNames.currency, getCurrencyByLocale(newLocale), cookieOptions);
+    if (autoChangeCookie.locale) {
+      $cookies.set(cookieNames.locale, newLocale, cookieOptions);
+    }
+
+    if (autoChangeCookie.currency) {
+      $cookies.set(cookieNames.currency, getCurrencyByLocale(newLocale), cookieOptions);
+    }
+
     window.location.href = context.route.fullPath;
   }
 }