Merge pull request #10 from ReeceM/feature-minor/options-callback-for…

…-sitemap-entry

adds options callback for sitemap entries [target: new v0.3.0]

.github/SECURITY.md

@@ -1,3 +1,119 @@
 # Security Policy
 
-If you discover any security related issues, please email reecestevenmay@gmail.com instead of using the issue tracker.
+**PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, [SEE BELOW](#reporting-a-vulnerability).**
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.2.x   | ✅ |
+| alpha   | ❌ these are for testing |
+| < 0.1   | ❌                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability, please send an email to Reece at zsh.rce@gmail.com.
+All security vulnerabilities will be promptly addressed.
+
+As the vulnerability is addressed and checked out I will attempt to keep you updated as things are sorted.
+
+Please provide a proof of concept for what you did to find the vulnerability as well as any possible real world exploits that could lead to actual leakage of data or exploit
+
+## Communication
+
+Once you have made initial contact via email, now public issues, if they are opened it will be if it is deemed alright.
+
+Please allow up to 24 Hours for a response.
+
+## Credits
+
+If you have found a vulnerability and it is found to be valid and is fixed, you will be credited with the discovery of the issue.
+
+Obviously, this being open-source, there wouldn't be any payment for discovering vulnerabilities.
+
+### Public PGP Key
+
+<details>
+<summary>🔑 Show Key</summary>
+```
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: OpenPGP v2.0.8
+Comment: https://sela.io/pgp/
+
+xsFNBF5sBTMBEACf9OoEsOBGVGJ1q3wKnJXYfsLZMyYzDXkrWZ70Jvxfvls1sbu5
+BJ7efrBzekgZ1aIoOjjZ2qXMaGHv0FCJLRqL3Wiv7kiMlc59q0Zr7ZMMU5FGASNl
+f8iw1craew5bRfEqD6zcXR0MQbjoCLfpIVa8YJhe5k/NZhexybPNlevkYD0CTRqv
+5alnFu2gEkx+sOlWUvCOfMbqo+UvMIS6yBWmlhbi/gYiFwzrm2CZrgTSotPBjNyX
+QU8gzP2PCW1eFWOoj/hNLPzfglK5ZCfLX6Q6keALrJzlHOLsb/wXdWg/A16Nfktz
+NN3nu3JRJIZYLSUfzjNFAZmS4RY0mswufTzQ8K10da7xRIfECzGVNABv0UslVdaJ
+HufZ6cbuiVOUGpRWzFt0/CJqaR3Ok4SBOxLUy/xsKerfZpNmFvxiTXvpEt0NOWRO
+M3YpA2H8jfcnhSfychCvGCA11cCnyqxL4SXrqe7OLGBQgTZg4EvSM52VNwANPbNB
+qNNBcC2VRw1580730mOPK3Mev7ojfEJvB6NjsHQhJu8AGrOlG+XZzfKtb/nGP9XJ
+WhIoNPrJHqqgd/sjwPAvE7sooo7pubjgxn7RQVV87/jG44e50D0gpn9z6Hm0q5vG
+X0jJ0VrC0obwE7BbY4o6PDTo9l2evO0BQWxLREgCa7SDwxYn5qU0plbIVwARAQAB
+zRF6c2gucmNlQGdtYWlsLmNvbcLBcAQTAQoAGgUCXmwFMwIbLwMLCQcDFQoIAh4B
+AheAAhkBAAoJEFiTJcq5H0SyH14P/AhjbDsG/nlfqlp4aFlHpbd7aRo1JDEYYaDe
+EongUAkqRLafZRC2KCUDfbvdey8FqTKNPPiKI5ELQHnhxauBAtwmOBcN+N1LzMl4
+T3F/mx4/r6kf98TeBcIjxZmL0Q/4H0T3eSeRspreVLeXyIp0WnZYxBzgMK5ZuXxJ
+ovBqXlKrRjz3HZehO2KA7IjqdH9HAyWYtK0plJrptayJN82+iqn0U+ut2DKjYUU2
+BHiDakb6zpf6S4tbjuEA7WG+vr/6JYn/fxYijfwCuoQBLt+Xk3y5LX1zAauNVRTE
+i91PSDKEamYuF/P+JXQADrjk0kRZoSX6bdqd/FmxaQyIn/O53CMoqjnCzKtxncim
+vZF2/A/KG5d6Fk1bwOA/652XwSvYIvO2GLISriclsnUnxGZILibJbwH4MqRFrgTq
+2vKUxOHleogUj7gtRMYILRI2m+340xRdKt8DMkb31woK7WlQlGp13Ra/zla/1LpX
+MIo28mv9DW1Jh9LNwWZALDlQQyX8zbrdc3jExK2dKwY0xonw1FWKi5xH+nx0+zPE
+JOvYPlj+YKTPdA1oElY7CnV4qE4g4lRUkfU83z6HTVob4wEJ40VltK0YqNBHvL34
+YYU2i3RNwCNEIzWWbvoNyPOSlpk0hpLqWjKs5uWke8ktIYFi5VuX6jinYi74alN0
+FLgTwQmXzsBNBF5sBTMBCADK7/UTHgR61I47rz8YI4Ll3kXIzYc9YFPKOhUf7T0Y
+j038tWsn6REcs60q/S9nbL89F5gOGDCcd2PykQXtpZCGenZ0TeFXzVSnJ0nQq9eU
+6mMWUT5ODAFIgmRk/PMyJs5f08u7Yx35jNTMEeZ69X8ewDSW0/7yRH9RFwergAwP
+MHmfjKcGYZew7n8dGJWvyu9vnHtZp9TbOxEZVKXJKjDJnzWSmuqVh1C+n6kYXIQX
+MXFVZdfQEk6AiNTAwnzV2bKahyxq6Alw87ZVPNGnycENP+RuNWrFrAfu5UQSgnOG
+st7mqqESZOnqkbv3BQbmaK6Tt1A5QcbA/Cp1G3vrxGVzABEBAAHCwoMEGAEKAA8F
+Al5sBTMFCQ8JnAACGy4BKQkQWJMlyrkfRLLAXSAEGQEKAAYFAl5sBTMACgkQPMpW
+wQb/Lo9XWggApEvGHt7OXN6kpQyOdUTRqsz6TibpTsQsweQW2IBnv4gjTDGTpQUU
+G/oYhfcolT5h0TDTe+/AxGPGdJa1S0Yu6xUESiMmE2y24bFOzxOKdISdW89hj/6y
+U+hsfv2yce6RY/UgX8GIQyXlhN0rZhL6kwCZ7uKCTqeOxEblYm2CulL3WYUjFOWG
+YHDQMjp3GzspUDeYDMQ2agihbP2FD4PL+zNe989NytyxrwxVGlUSUcPyj2Jp/2+E
+GVQPQv8jxcZBXRvz2irJM/eS/ckOXNfxbYg/scqocpe1Nr7F2U8dQafL8t34XKVm
+g4CwLSytKtjE7TMqxVg1WgocqfjnhSAhPmIDD/jEhVGDvr4+YkoCjGWOxBP7dWw5
+xBKclMsnguG7E4cUeZ+vt8s61iikDYl/upJnT9s88w2bp8DN8yHjwCsFws5STv0G
+b6wi+3IFu0Z9IL3692C2aARD44+LK9bttGhxn9eOeZk7kOni9njGSmFpJp2HHcMT
+cRvj09UL0wkeenCKJTwUGbilVO+ZjldvktGSnF0UPJs7BEag587RSQT5DBfJnRqt
+/ma1vJYieNWSVP3c33whKykxUnRLpn+GnUbhti7iOgCNy6xnTGTe3A9uSDi+7UHl
+SqpE1GgxcY/QxrajP+eEHhARkWHR5zkjQ/MkuFr2L8MXiBP8rnlW1buCMK480/JC
+igr61UJ8xB5aEXak00yBErP+3rSaI9jZp76ylo9lcf72O+KG1h0BvlAf0SNjElpx
+GP3m+DpWFQ8YlpGo+QEfRdTuFbG2R3jaCXBU2DECqPTxyOWH5dzXUaUtgT9L4N5f
+tCHmHugPXra7bcYf8xHMx2Vx4nMCsVisWMILv8aD4seTytGf3xX7/6UYKBsRrm6R
+94HNBVAjmbeC/5Qr3OorNhtGtYu5kc2bO4S730TtuNch/kErP7aYFMtYAokOA0WU
+RUK98fVV8yxq655ISxW01B3kRWYcSNmHMvbC3Yccn5OQKfB1qLHMt5/1Z0qw560L
+bgfWrGES7k3bzk9/zsBNBF5sBTMBCADCzyInJ1a9wV3NAcoVGz1SkjyZ/TJnKeKN
+BWHxjVrWMHuZtOHHP6bWnA7eew+Oso//hGmQ3YxMLojtwFLuyDzXeblhYmjtHaYR
+93mpkoeCMaZ5+HJcUFuhWtqk2fzJ7lu0tsywzSC75dR7/bUdNlur3s2trGHJtHTU
+qhFUOI8BJQ8yW4KWZm1XQejzMcKT2KHHVSOCjMDWVzmdFJtisP7V+yMrSsNxasL5
+cWHe1nmXsowsPveTqq9AsF/nLqkrwTfHSgpp3+XDTWNzxIn65Ll72yPXFdOLrlIR
+RGd/d+26QkAPybWmSvAAY6JWc2+SurJ8BeYCk+c61V0SbtIWMoMhABEBAAHCwoQE
+GAEKAA8FAl5sBTMFCQ8JnAACGy4BKQkQWJMlyrkfRLLAXSAEGQEKAAYFAl5sBTMA
+CgkQ/IEj9o9lX167jgf/XXhL7RuYavF9ZfONIdO+Mn0Zx3WEw0WmWNZCSLA8CbHa
+Vpojb7CP79p9bdE/4qlSKmLx5MpziCZuVvG1X25N1VgWden3ZDK8tWRjeh2VzAOh
+Q/ioFrwiEIwhZSfqFFs8H6Pz1lDL777QOX9UrOgWmtk+/ciwXa7VVV5Fs+wdGEg5
+8fwBymY+F/TCTK/k6bMJYBOIE8iYhhSAc1daYMQ5qv5MOTCwZvCt4iqwtc/oOhvW
+K7D+lgg3UrgfA2xeMgz1322k2CRNfaeHujMmXOpVNmPspARd6pI5q83aVzLqrVQX
+Mo6WUj1FssHtJ4+HjOP3NNWGg9gh7cIzo22kpi5JeyCSD/9H1ozJ2INiXqpF3ydC
+GdCtkQL+K3UdP0er53/kqanpfAjKlS2JDoaBesp79y9+jWpoeQx2dn0VT1eJwhdh
+/eSNCOq4JeT8bIqHWX+YtmItSQ+ZQloCqSQB+9uNvGuYTzcYgEif4r6GG5TrY1nT
+ksROTPa/lbWPVuatJcwHAdyb96zPNTYMYNroIbmWFmNXOpnnrjyNWnHEpVD4npZz
+ULuZ6r9rGM0rjTCO2vnMgOOE7dfvWlnXMjIU8uQ8DSL7w1DgsQuB3xhSV6V55j7+
+8EElgQ7bMcI1MXOgYiVRjoon2b1Xf4hre5U49aNLkWC9sDQSBPp3jLhjKWDry2BZ
+M4O1rXC9FJil/9vENOhpAelvkPduW8PjsIhkouxconQw59oYGMvgIsL/8yl06uDY
+Q0DbTp4TRXkIc69Rj/nQH8M/uqOHl/2hmYinC5s548Lza11hAarSa5uYqNZoOs/e
+xzSi2OCAFlsWrPIGOJVlBtGtLsDmt2PPVSsU+8PVqSndi8pERn9eTuykHkK30aHr
+sBJkv5/6RbNqvbTFnMDEct95FiqE2kWAZrHHP8ueN9Io3IzyUbkpWlJE/h9Mzq7T
+5kLyqq2eqoNIIXccgL1tRTCl30i8hQDc9tarJ52f/6eV2EIZr1DH/u7CZd2YcH/I
+WSP9/fPhYMd+HwxBDDUCc+taPQ==
+=dwpr
+-----END PGP PUBLIC KEY BLOCK-----
+```
+</details>

.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
+        node-version: [12.x, 14.x, 15.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

.gitignore

@@ -1,5 +1,7 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
+.vscode
+
 # dependencies
 /node_modules
 /.pnp

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+This is for version 0.3.0
+
+### Added
+- Option to make use of callback in `optionsMapPerDocumentType` see Discussion [Lastmod support #8](https://github.com/ReeceM/prismic-sitemap/discussions/8)
+- Added option to have a static path list of urls for normal routes that aren't dynamic
+
+### Changed
+- Made the URL result from the linkResolver take priority on results that go into the sitemap
+- The `sitemapConfig` option is using the `lastmodDateOnly = true` setting to ensure all lastmod dates are `YYYY-MM-DD` only. But can be disabled to keep UTC time.
+
 ## [0.2.0] - 2021-06-14
 
 ### Changed

README.md

@@ -5,13 +5,15 @@
 [![npm](https://img.shields.io/npm/v/@reecem/prismic-sitemap)](https://www.npmjs.com/package/@reecem/prismic-sitemap)
 [![npm](https://img.shields.io/npm/dt/@reecem/prismic-sitemap)](https://www.npmjs.com/package/@reecem/prismic-sitemap)
 
-A sitemap generator for Next.js websites based on the pages in your [Prismic.io](https://prismic.io) backed Next.js application.
+An easy to configure sitemap generator for Next.js websites based on the pages in your [Prismic.io](https://prismic.io) CMS.
 
 ## About
 
-This package uses the [Sitemap.js](https://github.com/ekalinin/sitemap.js) package to generate the sitemaps as it handles all the needed stuff for sitemaps. This also gives the end user flexibility in generating the sitemap
+This package uses the [Sitemap.js](https://github.com/ekalinin/sitemap.js) package to generate the sitemaps as it handles all the needed stuff for sitemaps. This also gives the end user flexibility in generating the sitemap.
 
-This package is also inspired by the live steam from Prismic.io where they built a sitemap generator.
+It aims to simplify the configuration required to create the sitemap, and also include it in the build process of your Next.js site by extending the `next.config.js` file.
+
+> This package is also inspired by the live steam from Prismic.io where they built a sitemap generator. But wanting to make it better like.
 
 ## Installation
 
@@ -62,8 +64,16 @@ module.exports = withPrismicSitemap({
         apiEndpoint: API_ENDPOINT,
         hostname: SITE_URL,
         optionsMapPerDocumentType: {
-            post: { changefreq: "weekly", priority: 0.8 },
-            page: { changefreq: "monthly", priority: 1 }
+          // setting the update date of the article.
+          post: (document) => {
+            return { 
+              // get the last time the document was published in Prismic
+              lastmod: document.last_publication_date,
+              changefreq: "weekly", 
+              priority: 0.8 
+            }
+          }
+          page: { changefreq: "monthly", priority: 1 }
         },
         documentTypes: ['page', 'post']
     }
@@ -169,6 +179,22 @@ module.exports = withPrismicSitemap({
 })
 ```
 
+### `<lastmod>` support
+
+The package makes use of lastmod support for the sitemap, this would need to be set by the user if you would want the date to come through at the current version of `0.3.0`.
+
+Because the Sitemap file is written using a separate package, it supports parsing the date straight to the `YYYY-MM-DD` format, if you would like it to have the time as well, you will need to override the setting in the config:
+
+```javascript
+  sitemap: {
+
+    sitemapConfig: {
+      lastmodDateOnly: false,
+    },
+
+  }
+```
+
 ## API
 
 The sitemap object is made up of the following:
@@ -182,25 +208,62 @@ The sitemap object is made up of the following:
     accessToken = String|null,
     hostname = String,
     fileName = String,
-    optionsMapPerDocumentType = Object, /** @see https://github.com/ekalinin/sitemap.js/blob/master/api.md#sitemap-item-options */
+    optionsMapPerDocumentType = Object|Object<Function>,
+    defaultEntryOption = Object,
+    staticPaths = Array<Object>,
     documentTypes = Array,
-    sitemapConfig = Object /** @see https://github.com/ekalinin/sitemap.js#options-you-can-pass */
+    sitemapConfig = Object
   }
 }
 ```
 
 |Option|Type|eg|Description|
 |------|----|--|-----------|
-|linkResolver|function|`doc => {return `${doc.uid}`;}`| This is the Prismic.io link resolver, this could be custom, or used from the prismic-configuration files.|
+|linkResolver|function|```doc => {return `/path/${doc.uid}`;}```| This is the Prismic.io link resolver, this could be custom, or used from the prismic-configuration files.|
 |apiEndpoint|string|`'https://some-repository-on-prismic.cdn.prismic.io/api/v2'`| This is the URL of your Prismic repository, the API version of it.|
 |accessToken|string(optional)|`'random_api_string_that_you_get'`| This is the Access token used to access private Prismic Repositories|
 |hostname|string|`'http://example.com/'`| The hostname of your Vercel/Next.js application|
 |fileName|string|`'sitemap.xml'`| The name of the sitemap, it is always placed inside public|
-|optionsMapPerDocumentType|object|`{ page: { changefreq: "monthly", priority: 1 }, }`| The options for the documents that are indexed, this can also have other options, found at [https://github.com/ekalinin/sitemap.js/blob/master/api.md#sitemap-item-options](https://github.com/ekalinin/sitemap.js/blob/master/api.md#sitemap-item-options)|
+|optionsMapPerDocumentType|object|`{ page: { changefreq: "monthly", priority: 1 }, post: (doc) => {lastmod: doc.last_publication_date}}`| The options for the documents that are indexed, this can also have other options, found at [https://github.com/ekalinin/sitemap.js/blob/master/api.md#sitemap-item-options](https://github.com/ekalinin/sitemap.js/blob/master/api.md#sitemap-item-options)|
 |documentTypes|array|`['homepage', 'page', 'pricing', 'legal']`||
+|defaultEntryOption|object (optional)| `{ changefreq: "monthly", priority: 1, }`| This is the default to add when nothing exists for the type or callback for entries|
+|staticPaths|array|`[{ url: '/static/path', changefreq: "yearly", priority: 1, lastmod: '2000-01-01'}]`| Use this if you would like to define a custom path for the Sitemap that doesn't come from the CMS |
 |sitemapConfig|object|| see [https://github.com/ekalinin/sitemap.js#options-you-can-pass](https://github.com/ekalinin/sitemap.js#options-you-can-pass)|
 
 
+### `optionsMapPerDocumentType`
+
+The `optionsMapPerDocumentType` setting for the sitemap value allows you to configure the object result for the sitemap entry for the specific document
+
+This accepts a object with keys to the document type from Prismic, the value can be a object, or a callback.
+
+**Using the Callback**
+
+This option allows you to determine extra data about the document and return a object to be written to the Sitemap, there isn't a need to return the URL value, and this will be purged from the result anyway in favour of the `linkResolver` result. This is for consistency reasons.
+
+The primary reason to add this is because of using the `<lastmod>` XML attribute in the Sitemap to improve indexing by Google or other search engines.
+
+To make use of this, you can do the following logic:
+
+```javascript
+
+module.exports = withPrismicSitemap({
+  sitemap: {
+    // ... other cofing
+    optionsMapPerDocumentType: {
+      post: (document) => {
+        return {
+          lastmod: document.last_publication_date ? document.last_publication_date : (new Date()).toJSON(),
+          changefreq: 'monthly'
+        };
+      }
+    },
+  }
+})
+```
+
+---
+
 ## Testing
 
 ```bash