@faststore/core 3.99.1 → 4.0.0-dev.1

package/cms/faststore/sections.json

@@ -222,6 +222,21 @@
                 "score_desc"
               ]
             },
+            "submitButtonAriaLabel": {
+              "title": "Submit Search Button aria-label",
+              "type": "string",
+              "default": "Submit Search"
+            },
+            "searchHistoryTitle": {
+              "title": "Search History Title",
+              "type": "string",
+              "default": "History"
+            },
+            "searchTopTitle": {
+              "title": "Top Search Title",
+              "type": "string",
+              "default": "Top search"
+            },
             "quickOrderSettings": {
               "title": "Quick Order settings",
               "type": "object",
@@ -334,6 +349,29 @@
                     }
                   }
                 },
+                "invalidQuantityToastLabels": {
+                  "title": "Invalid quantity toast",
+                  "description": "This toast will be displayed when the quantity is out of the range of the min and max values.",
+                  "type": "object",
+                  "properties": {
+                    "title": {
+                      "title": "Title",
+                      "type": "string",
+                      "default": "Invalid quantity!"
+                    },
+                    "message": {
+                      "title": "Message",
+                      "type": "string",
+                      "description": "If the message has %{min}, %{max} and %{quantity} placeholders, they will be replaced by the min, max and quantity values.",
+                      "default": "The quantity you entered is outside the range of '%{min}' to '%{max}'. The quantity was set to '%{quantity}'."
+                    }
+                  }
+                },
+                "outOfStockLabel": {
+                  "title": "Out of Stock Label",
+                  "type": "string",
+                  "default": "Out of stock"
+                },
                 "drawer": {
                   "title": "Quick Order Drawer",
                   "type": "object",
@@ -777,6 +815,16 @@
                   }
                 }
               }
+            },
+            "loadingLabel": {
+              "title": "Loading Label",
+              "type": "string",
+              "default": "Loading..."
+            },
+            "collapseSearchAriaLabel": {
+              "title": "Collapse Search Button aria-label",
+              "type": "string",
+              "default": "Collapse search bar"
             }
           }
         },
@@ -870,6 +918,92 @@
                 }
               }
             },
+            "localizationButton": {
+              "type": "object",
+              "title": "Localization Button",
+              "properties": {
+                "shouldDisplayLocalizationButton": {
+                  "type": "boolean",
+                  "title": "Should display localization button?",
+                  "default": false
+                },
+                "icon": {
+                  "title": "Icon",
+                  "type": "object",
+                  "properties": {
+                    "icon": {
+                      "title": "Icon",
+                      "type": "string",
+                      "enumNames": ["Globe"],
+                      "enum": ["Globe"],
+                      "default": "Globe"
+                    }
+                  }
+                },
+                "ariaLabel": {
+                  "title": "Aria Label for localization selector",
+                  "type": "string",
+                  "default": "Open localization selector"
+                }
+              }
+            },
+            "localizationSelector": {
+              "type": "object",
+              "title": "Localization Selector",
+              "properties": {
+                "title": {
+                  "title": "Title",
+                  "type": "string",
+                  "default": "Select language and currency"
+                },
+                "languageLabel": {
+                  "title": "Language Label",
+                  "type": "string",
+                  "default": "Language"
+                },
+                "currencyLabel": {
+                  "title": "Currency Label",
+                  "type": "string",
+                  "default": "Currency"
+                },
+                "description": {
+                  "title": "Description",
+                  "type": "string",
+                  "default": "Changing the language or currency may affect prices, promotions and availability."
+                },
+                "saveLabel": {
+                  "title": "Save Button Label",
+                  "type": "string",
+                  "default": "Save"
+                },
+                "errorMessages": {
+                  "title": "Error Messages",
+                  "type": "object",
+                  "properties": {
+                    "noBindingFound": {
+                      "title": "No Binding Found Error",
+                      "type": "string",
+                      "default": "Unable to save configuration. No matching store found."
+                    },
+                    "invalidUrl": {
+                      "title": "Invalid URL Error",
+                      "type": "string",
+                      "default": "Invalid redirect URL. Please try again."
+                    },
+                    "noCurrencies": {
+                      "title": "No Currencies Error",
+                      "type": "string",
+                      "default": "No currencies available for this language."
+                    },
+                    "defaultError": {
+                      "title": "Default Error",
+                      "type": "string",
+                      "default": "An error occurred. Please try again."
+                    }
+                  }
+                }
+              }
+            },
             "pageLinks": {
               "title": "Links",
               "type": "array",
@@ -1146,11 +1280,13 @@
               "properties": {
                 "url": {
                   "title": "Link URL",
-                  "type": "string"
+                  "type": "string",
+                  "default": "/"
                 },
                 "title": {
                   "title": "Link Title",
-                  "type": "string"
+                  "type": "string",
+                  "default": "Go to Home"
                 }
               }
             }
@@ -2000,17 +2136,25 @@
       "title": "Breadcrumb",
       "description": "Configure the breadcrumb icon and depth",
       "type": "object",
-      "required": ["icon", "alt"],
+      "required": ["icon", "alt", "fallbackLabel"],
       "properties": {
+        "fallbackLabel": {
+          "title": "Fallback label",
+          "description": "Label shown when there are no breadcrumb items to display, such as on the Search page.",
+          "type": "string",
+          "default": "All Products"
+        },
         "icon": {
           "title": "Icon",
           "type": "string",
           "enumNames": ["House"],
-          "enum": ["House"]
+          "enum": ["House"],
+          "default": "House"
         },
         "alt": {
           "title": "Alternative Label",
-          "type": "string"
+          "type": "string",
+          "default": "Go to homepage"
         }
       }
     }
@@ -2051,6 +2195,11 @@
             }
           }
         },
+        "loadingLabel": {
+          "title": "Loading Label",
+          "type": "string",
+          "default": "Loading..."
+        },
         "buyButton": {
           "title": "Buy Button",
           "type": "object",
@@ -2145,6 +2294,11 @@
               "title": "Description section title",
               "type": "string",
               "default": "Description"
+            },
+            "accordionAriaLabel": {
+              "title": "Product description accordion aria label",
+              "type": "string",
+              "default": "Product Description Content"
             }
           }
         },
@@ -2156,6 +2310,24 @@
               "title": "Should use unit multiplier?",
               "type": "boolean",
               "default": false
+            },
+            "invalidQuantityToastLabels": {
+              "title": "Invalid quantity toast",
+              "description": "This toast will be displayed when the quantity is out of the range of the min and max values.",
+              "type": "object",
+              "properties": {
+                "title": {
+                  "title": "Title",
+                  "type": "string",
+                  "default": "Invalid quantity!"
+                },
+                "message": {
+                  "title": "Message",
+                  "type": "string",
+                  "description": "If the message has %{min}, %{max} and %{quantity} placeholders, they will be replaced by the min, max and quantity values.",
+                  "default": "The quantity you entered is outside the range of '%{min}' to '%{max}'. The quantity was set to '%{quantity}'."
+                }
+              }
             }
           }
         },
@@ -2323,6 +2495,74 @@
             }
           }
         },
+        "sortBySelector": {
+          "title": "Sort by selector",
+          "type": "object",
+          "required": ["label", "options"],
+          "properties": {
+            "label": {
+              "title": "Label",
+              "type": "string",
+              "default": "Sort by"
+            },
+            "options": {
+              "title": "Options labels",
+              "type": "object",
+              "required": [
+                "price_desc",
+                "price_asc",
+                "orders_desc",
+                "name_asc",
+                "name_desc",
+                "release_desc",
+                "discount_desc",
+                "score_desc"
+              ],
+              "properties": {
+                "price_desc": {
+                  "title": "Price - Descending",
+                  "type": "string",
+                  "default": "Price, descending"
+                },
+                "price_asc": {
+                  "title": "Price - Ascending",
+                  "type": "string",
+                  "default": "Price, ascending"
+                },
+                "orders_desc": {
+                  "title": "Orders - Descending",
+                  "type": "string",
+                  "default": "Top sales"
+                },
+                "name_asc": {
+                  "title": "Name - Ascending",
+                  "type": "string",
+                  "default": "Name, A-Z"
+                },
+                "name_desc": {
+                  "title": "Name - Descending",
+                  "type": "string",
+                  "default": "Name, Z-A"
+                },
+                "release_desc": {
+                  "title": "Release - Descending",
+                  "type": "string",
+                  "default": "Release date"
+                },
+                "discount_desc": {
+                  "title": "Discount - Descending",
+                  "type": "string",
+                  "default": "Discount"
+                },
+                "score_desc": {
+                  "title": "Score - Descending",
+                  "type": "string",
+                  "default": "Relevance"
+                }
+              }
+            }
+          }
+        },
         "filter": {
           "title": "Filter",
           "type": "object",
@@ -2421,6 +2661,16 @@
               "title": "Sponsored Label",
               "type": "string",
               "default": "Sponsored"
+            },
+            "buttonLabel": {
+              "title": "Button Label",
+              "type": "string",
+              "default": "Add"
+            },
+            "outOfStockLabel": {
+              "title": "Out of Stock Label",
+              "type": "string",
+              "default": "Out of stock"
             }
           }
         },
@@ -2450,6 +2700,8 @@
                 "icon": {
                   "title": "Icon",
                   "type": "string",
+                  "enumNames": ["CircleWavyWarning"],
+                  "enum": ["CircleWavyWarning"],
                   "default": "CircleWavyWarning"
                 }
               }
@@ -2471,6 +2723,8 @@
                 "icon": {
                   "title": "Icon",
                   "type": "string",
+                  "enumNames": ["RocketLaunch"],
+                  "enum": ["RocketLaunch"],
                   "default": "RocketLaunch"
                 }
               }
@@ -2519,15 +2773,32 @@
                       "type": "string",
                       "default": "Filters"
                     },
-                    "productNameFilterLabel": {
-                      "title": "Filter by product name text",
-                      "type": "string",
-                      "default": "Product name"
-                    },
-                    "sortLabel": {
-                      "title": "Sort filter text",
-                      "type": "string",
-                      "default": "Sort by"
+                    "sortLabels": {
+                      "title": "Sort labels",
+                      "type": "object",
+                      "properties": {
+                        "label": {
+                          "title": "Sort filter text",
+                          "type": "string",
+                          "default": "Sort by"
+                        },
+                        "options": {
+                          "title": "Sort options",
+                          "type": "object",
+                          "properties": {
+                            "productByName": {
+                              "title": "Product Name",
+                              "type": "string",
+                              "default": "Product Name"
+                            },
+                            "productByPrice": {
+                              "title": "Price",
+                              "type": "string",
+                              "default": "Price"
+                            }
+                          }
+                        }
+                      }
                     },
                     "toggleFieldLabel": {
                       "title": "Toggle filter text",
@@ -2544,11 +2815,6 @@
                       "type": "string",
                       "default": "Add to cart"
                     },
-                    "priceLabel": {
-                      "title": "Price text",
-                      "type": "string",
-                      "default": "Price"
-                    },
                     "priceWithTaxLabel": {
                       "title": "Price with taxes text",
                       "type": "string",
@@ -2636,6 +2902,22 @@
             }
           }
         },
+        "emptyCart": {
+          "title": "Empty Cart",
+          "type": "object",
+          "properties": {
+            "title": {
+              "title": "Title",
+              "type": "string",
+              "default": "Your Cart is empty"
+            },
+            "buttonLabel": {
+              "title": "Button Label",
+              "type": "string",
+              "default": "Start Shopping"
+            }
+          }
+        },
         "checkoutButton": {
           "title": "Checkout button",
           "type": "object",
@@ -2963,8 +3245,9 @@
             "icon": {
               "title": "Icon",
               "type": "string",
-              "enumNames": ["CircleWavy Warning"],
-              "enum": ["CircleWavyWarning"]
+              "enumNames": ["CircleWavyWarning"],
+              "enum": ["CircleWavyWarning"],
+              "default": "CircleWavyWarning"
             },
             "alt": {
               "title": "Alternative Label",
@@ -3018,6 +3301,32 @@
       }
     }
   },
+  {
+    "name": "ScrollToTopButton",
+    "requiredScopes": ["plp", "search"],
+    "schema": {
+      "title": "Scroll to Top Button",
+      "description": "A button to scroll the page back to the top",
+      "type": "object",
+      "required": ["text"],
+      "properties": {
+        "text": {
+          "title": "Button Text",
+          "description": "Text displayed on the button",
+          "type": "string",
+          "default": "Scroll to top"
+        },
+        "iconPosition": {
+          "title": "Icon Position",
+          "description": "Position of the icon relative to the text",
+          "type": "string",
+          "enumNames": ["Left", "Right"],
+          "enum": ["left", "right"],
+          "default": "left"
+        }
+      }
+    }
+  },
   {
     "name": "ShoppingAssistant",
     "requiredScopes": [],

package/discovery.config.default.js

@@ -3,7 +3,6 @@ module.exports = {
     title: 'FastStore Starter',
     description: 'Fast Demo Store',
     titleTemplate: '%s | FastStore',
-    author: 'Store Framework',
     name: 'FastStore',
     publisherId: '',
     plp: {
@@ -70,6 +69,51 @@ module.exports = {
     refreshAfter: null, // timestamp in seconds e.g. '1743042990'
   },
 
+  // Localization feature flag
+  localization: {
+    enabled: false,
+
+    // generated by @faststore/cli when localization is enabled
+    defaultLocale: 'pt-BR',
+    regions: {
+      BR: {
+        code: 'BR',
+        name: 'Brazil',
+        dateFormat: 'DD/MM/YYYY',
+        timeFormat: '12h',
+        timeFormatMask: 'hh:mm a',
+        unitSystem: 'metric',
+        defaultTimezone: 'GMT-3',
+      },
+    },
+    locales: {
+      'pt-BR': {
+        code: 'pt-BR',
+        name: 'Português',
+        languageCode: 'pt',
+        languageName: 'Portuguese',
+        script: 'Latn',
+        textDirection: 'ltr',
+        regionCode: 'BR',
+        bindings: [
+          {
+            currencyCode: 'BRL',
+            url: 'https://brandless.fast.store/pt-BR',
+            salesChannel: '1',
+            isDefault: true,
+          },
+        ],
+      },
+    },
+    currencies: {
+      BRL: {
+        code: 'BRL',
+        name: 'Brazilian Real',
+        symbol: 'R$',
+      },
+    },
+  },
+
   // Default cart
   cart: {
     id: '',
@@ -88,12 +132,12 @@ module.exports = {
 
   // Preview redirects
   previewRedirects: {
+    404: '/404',
+    500: '/500',
     home: '/',
     plp: '/office',
     search: '/s?q=headphone',
     pdp: '/apple-magic-mouse/p',
-    500: '/500',
-    404: '/404',
   },
 
   // Lighthouse CI
@@ -122,6 +166,8 @@ module.exports = {
   analytics: {
     // https://developers.google.com/tag-platform/tag-manager/web#standard_web_page_installation,
     gtmContainerId: 'GTM-PGHZ95N',
+    serviceName: 'faststore-proxy',
+    otelEnabled: true,
   },
 
   cms: {

package/next-env.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
+import './.next/types/routes.d.ts'
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

package/next.config.js

@@ -1,6 +1,21 @@
-// @ts-check
 const path = require('path')
 const storeConfig = require('./discovery.config')
+const { buildI18nDomains } = require('./scripts/i18n')
+
+// Load locales settings (generated by CLI during build)
+const localesSettings = storeConfig.localization
+
+const getRootFolder = () => {
+  if (__dirname.endsWith('.faststore')) return path.join(__dirname, '..')
+
+  return path.join(__dirname, '../../')
+}
+
+console.log(`
+  Root folder at: ${getRootFolder()}
+  AccountID: ${storeConfig.api?.storeId ?? 'Unknown'}
+  Analytics Enabled: ${storeConfig.analytics?.otelEnabled ?? false}
+`)
 
 /**
  * @type {import('next').NextConfig}
@@ -14,31 +29,44 @@ const nextConfig = {
       transpilePackages: storeConfig.experimental.transpilePackages,
     }),
   images: {
-    domains: [`${storeConfig.api.storeId}.vtexassets.com`],
+    remotePatterns: [
+      {
+        protocol: 'https',
+        hostname: `${storeConfig.api.storeId}.vtexassets.com`,
+        pathname: '/**',
+      },
+    ],
     deviceSizes: [360, 412, 540, 768, 1280, 1440],
     imageSizes: [34, 68, 154, 320],
     loader: 'custom',
     loaderFile: './src/components/ui/Image/loader.ts',
   },
-  i18n: {
-    locales: [storeConfig.session.locale],
-    defaultLocale: storeConfig.session.locale,
-  },
+  i18n: localesSettings.enabled
+    ? {
+        locales: Object.keys(localesSettings.locales || {}),
+        defaultLocale: localesSettings.defaultLocale,
+        localeDetection: false,
+        domains: buildI18nDomains(localesSettings),
+      }
+    : {
+        locales: [storeConfig.session.locale],
+        defaultLocale: storeConfig.session.locale,
+      },
   sassOptions: {
-    additionalData: `@import "src/customizations/src/styles/custom-mixins.scss";`,
+    silenceDeprecations: ['if-function', 'legacy-js-api'],
   },
   // TODO: We won't need to enable this experimental feature when migrating to Next.js 13
   experimental: {
     instrumentationHook: true,
     scrollRestoration: !storeConfig.experimental.scrollRestoration,
-    /*
-     * The FastStore Discovery CLI will update this value to match the path where the
-     * command is being run, because that is where the node_modules directory is.
-     * For discovery-only paths, that is the user directory, and for monorepo, that is the base
-     * of the monorepo
-     * */
-    outputFileTracingRoot: path.join(__dirname, '../'),
   },
+  /*
+   * The FastStore Discovery CLI will update this value to match the path where the
+   * command is being run, because that is where the node_modules directory is.
+   * For discovery-only paths, that is the user directory, and for monorepo, that is the base
+   * of the monorepo
+   * */
+  outputFileTracingRoot: getRootFolder(),
   webpack: (config, { isServer, dev }) => {
     // https://github.com/vercel/next.js/discussions/11267#discussioncomment-2479112
     // camel-case style names from css modules
@@ -58,22 +86,16 @@ const nextConfig = {
       config.optimization.splitChunks.maxInitialRequests = 1
     }
 
-    if (storeConfig.experimental.preact && !isServer && !dev) {
-      Object.assign(config.resolve.alias, {
-        react: 'preact/compat',
-
-        'react-dom/test-utils': 'preact/test-utils',
-
-        'react-dom': 'preact/compat',
-      })
-    }
-
     return config
   },
   redirects: storeConfig.redirects,
   rewrites: storeConfig.rewrites,
-  eslint: {
-    ignoreDuringBuilds: true,
+  turbopack: {
+    root: getRootFolder(),
+    // https://nextjs.org/docs/app/api-reference/turbopack#css-module-ordering
+    resolveAlias: {
+      '~*': '*',
+    },
   },
 }