Lastmod support

[mkbctrl]

Recently I was updating few sitemaps in order to meet updated google's requirements, where the changefreq and priority fields are kind of obsolete.

First I stumbled upon this information while working with another project in GatsbyJs:

source: https://www.gatsbyjs.com/plugins/gatsby-plugin-sitemap/
direct source: https://developers.google.com/search/docs/advanced/sitemaps/build-sitemap

Since I used your plugin today, I thought I will share this info with you, as I don't see this field in the output file. Hope you find it useful.

Btw, it's a great plugin, and thanks for saving me a lot of work ❤️

P.S. I am about to have a look how to add the lastmod field into your sitemap, hopefully I will be able to share some more insights.

[ReeceM]

Hi @mkbctrl,

Thank you for highlighting this. I am not aware of that and I think I will definitely make it an addition then, at least with the Prismic CMS data there is an updated date field that can be passed in.

At the moment, there is the option to use the optionsMapPerDocumentType object, but this doesn't have access to the current document data that is being passed in.

I am thinking then that I could make that then a function that can have the current document passed in, but also still be backwards compatible with the object only version.

So something like this:

// next.config.js


module.exports = withPrismicSitemap({
  sitemap: {
    // ... other cofing
    optionsMapPerDocumentType: {
      post: (doc) => {
        return {
          lastmod: doc.last_publication_date ? doc.last_publication_date : (new Date()).toJSON(),
          // below for any older things that use it
          changefreq: "weekly",
          priority: 0.8
        };
      }
    },
  }
})

I will have to have a look at this then as a very useful and practical feature, thank you for highlighting it 👍

[mkbctrl]

Your idea looks sharp, I think it's exactly what's required here. Since we are "speaking", in my project not all the pages are coming from prismic, some of them live only inside the nextjs app. Are you aware of a workaround to append such pages to your sitemap.xml? Even looping through a manually created array would be good enough, I think.

[ReeceM]

Sorry for the delay a between responses. At the moment, I am not aware of a work around with the current version, but I am having a look at it now though. 👍

What you have highlighted with the usage of some next static pages that exist already was something I was wondering about, but hadn't implemented yet.

Are those static pages, or dynamic ones? I am just wondering if allowing passing a extra list of routes for other pages or appending to the sitemap before writing with another function that can be called.

[ReeceM]

Hi @mkbctrl,

I have added the option to allow a callback to be placed inside the options map. There is also the addition to allow someone to place the usage of static paths in an array for them to be added to the list of the sitemap entries.

If you would like to test it, it will be available as @reecem/prismic-sitemap@^0.3.0-alpha.1.

If you would like you can test it and let me know if it is coming out alright for you too. You can see PR #10 for the changes that have been added and also the branch

[mkbctrl]

Other than that, everything works smoothly. Thanks a lot for great support 🍻 🍻 🍻 🍻 🍻 🍻 🍻

[ReeceM]

Hi @mkbctrl, thank you for the feedback.

I will have a look at the usage of the date format in YYYY-MM-DD, I might have to suggest that in the docs, or pass a helper function to convert the date to that format as the an end user would be returning that result, will have a look.

Regarding the static paths, I think the addition of allowing handling functions including the object might be better, I was wondering about adding that. I think it might be more consistent then.

Although in the current state, if someone would like the date updated each deploy for a static path, they can set the next.config.js file with the following:

{
    // other stuff
    staticPaths: [
        {
            url: 'example-1',
            lastmod: Date.now(),
        },
        {
            url: 'example-2',
            lastmod: '2021-01-01',
        },
        {
            url: 'example-3',
            lastmod: (new Date).toISOString(),
        }
    ]
}

But will have a look at passing a function and may make it async/await capable too if there is a page queried from elsewhere then.

Thank you again for the feedback and highlighting this 👍

[ReeceM]

The other option is to enable:

// next.config.js

module.exports = withPrismicSitemap({
  sitemap: {

    sitemapConfig: {
      lastmodDateOnly: true,
    },

  }
})

This affects the underlying library that builds the sitemap stream. This is also an option as it will force all dates to be the same and then there isn't a mix of the date formats.

[mkbctrl]

The other option is to enable:

// next.config.js

module.exports = withPrismicSitemap({
  sitemap: {

    sitemapConfig: {
      lastmodDateOnly: true,
    },

  }
})

This affects the underlying library that builds the sitemap stream. This is also an option as it will force all dates to be the same and then there isn't a mix of the date formats.

And I think that's how you should tackle this

[ReeceM]

And I think that's how you should tackle this

I will make it enabled by default if someone would want to disable it for some reason if they want the time as well. 👍 💯

[mkbctrl]

One not related issue, while trying to install your package in alpha version I was forced to switch to node v12, by default I run LTS v14. If it's not required by dependencies, maybe it's worth to change.

[mkbctrl]

My linter on gitlab CI doesn't like it as well:

error @reecem/prismic-sitemap@0.3.0-alpha.1: The engine "node" is incompatible with this module. Expected version "^12.0". Got "14.1.0"
error Found incompatible module.

[ReeceM]

That would be my fault, I think I misconfigured the node version stuff in wanting to make sure someone didn't have issues trying to use it on v10 of Node, will fix it now though, thank you 👍

[mkbctrl]

thanks 🍻 , please let me know once you find the time

[ReeceM]

will do 👍

[ReeceM]

version 0.3.0-alpha.2 should have the fixed things for the nom engine and the lastmod.

Works on my v14 node install

[ReeceM]

Hi @mkbctrl

Hope you are good, I released v0.3.0 yesterday with these additions and fixes, so if you would like that is the version that will get updates for any fixes now. (I won't push an alpha for that version now)

Hope it works and please let me know if there are any issues or feel free to open an issue if you would like to put more details in 👍

[mkbctrl]

I just installed the latest version (0.3) and took it for a ride. So far so good. Everything works as expected. I would like to thank you for your great support once again :))

[ReeceM]

Awesome 💯. I am glad it's working good then 👍