feat(dev/plugin): add localization to static pages

[alextaing]

This PR adds localization to static pages and adds an interface for StaticTemplateConfig. Localization can now be specified for static pages by including the following in the TemplateConfig.

export const config: StaticTemplateConfig = {
  name: "robots",
  locales: ["en", "es"]
};

This config is included in the templates.json/features.json to be consumed by Spruce as:

{
  "features": [
    {
      "name": "robots",
      "templateType": "JS",
      "staticPage": {
        "locales": ["en", "es"]
      }
    },
  ],
  "streams": []
}

Additionally, it was found that since static pages no longer have a single staticURL per featureName, the localDataManifest had to be refactored. This is because static pages now accept a document in their getPath function, meaning that when static pages may have different URLs depending on the document if the path uses the document's locale.

Furthermore, it was found that when running yext pages render to generate pages, static pages with a constant getPath return value multiple locales would only generate one static page. To deal with this behavior, pages will now throw an error when users have multiple static pages with identical paths.

J=SUMO-5451
TEST=manual

It was tested that you can specify locales in the TemplateConfig for static pages, and that they property show up in the templates.json. It was also tested that when yext pages generate-test-data is called, it generates a document for each locale specified in a static page.

[alextaing]

@mkilpatrick One thing of note that I ran into when testing: If we have a static page with more than one locale, but a constant getPath return value:

export const config: StaticTemplateConfig = {
  name: "robots",
  locales: ['en', 'zh']
};
export const getPath = () => {
  return `robots.txt`;
};

In dev, it creates two pages: robots.txt?locale=en and robots.txt?locale=zh. But, when we generate pages using yext pages render, it only has one page , robots.txt and is filled with the contents of the page with the en locale.

Is this something we want to address as a part of this item, or something that we should make an item for? As of now, I'm not sure whether we should expect one of the locales to be overwritten, or if it should have two pages as we do in dev.

[asanehisa]

lgtm

[mkilpatrick]

@mkilpatrick One thing of note that I ran into when testing: If we have a static page with more than one locale, but a constant getPath return value:

export const config: StaticTemplateConfig = {
  name: "robots",
  locales: ['en', 'zh']
};
export const getPath = () => {
  return `robots.txt`;
};

In dev, it creates two pages: robots.txt?locale=en and robots.txt?locale=zh. But, when we generate pages using yext pages render, it only has one page , robots.txt and is filled with the contents of the page with the en locale.

Is this something we want to address as a part of this item, or something that we should make an item for? As of now, I'm not sure whether we should expect one of the locales to be overwritten, or if it should have two pages as we do in dev.

This is a good question. Could you bring it up in the original Slack thread discussion? Perhaps we should instead throw an error that you've defined multiple locales but only one output path/html file can be created.

[mkilpatrick]

🔥