Feat: PLP - multiple templates rewrites

eduardoformiga commented 5 months ago

What's the purpose of this pull request?

This PR aims to add multiple-page templates for friendly URLs that are added using rewrites. It also add some tests.

The documentation is in this PR:

https://github.com/vtexdocs/dev-portal-content/pull/1157

How it works?

Using Rewrites with PLP template

FastStore enables the use of rewrites from Next.js to create a custom route. It's possible to enable the multiple-page template feature for the custom route as well by adding your rewrites function into the faststore.config.js file as the Next.js doc suggests:

async rewrites() {
  return [
    {
      source: '/my-office',
      destination: `/office`,
    },
  ]
},

or

async rewrites() {
  return {
    beforeFiles: [
      {
        source: '/my-office',
        destination: `/office`,
      },
    ],
    afterFiles: [],
    fallback: [],
  }
},

In the example above, the new source route /my-office will be rewritten to the existing destination route /office, using the /office template without changing the URL. In that way, you can use the existing destination route /office to map this template in the hCMS.

From the version of this PR, it's also possible to use the source route in the hCMS to map the template.

How to test it?

switch to the vendemo account in the cms config file (keeping the storeframework in the faststore.config.js just to keep the catalog). https://github.com/vtex/faststore/blob/37bca87b4f08002bcb74b3734e9b273d8560bee2/packages/core/src/server/cms/index.ts#L45
use this page OR create a new PLP in hCMS and use /test/my-officeor /office in the input from the settings tab
publish your page and run the project locally with yarn dev
both URLs (/test/my-officeor /office) should show the new template.