Created a sitemap of the website. (#70)

#### Enhancements and Updates

- Added a sitemap builder to the `builder` directory that generates a
sitemap and logs it to the console.
- Created a new model class for the sitemap builder to use.
- Split off the page info needed by the sitemap builder into a separate
TypeScript file.
- Added metadata to the pages for the sitemap, like date last updated.

#### General Technical Changes

- Generated a `sitemap.xml` file with all the pages of the website.
- Referred to this file in the `robots.txt` file.

#### Dependencies

- Added the `sitemap` dependency.
- Added the `tsx` dependency as a dev dependency.

#### Changes by

@tahoni

Author: tahoni

.npmrc

@@ -1,2 +1,2 @@
 @tahoni:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${NPM_TOKEN}
+//npm.pkg.github.com/:_authToken=${NPM_TOKEN_READ}

.vscode/tasks.json

@@ -13,9 +13,9 @@
       "options": {
         "env": {
           "NPM_TOKEN": "${NPM_TOKEN_READ}"
-        },
-        "detail": "Installs project dependencies using npm"
-      }
+        }
+      },
+      "detail": "Installs project dependencies using npm"
     },
     {
       "label": "Run Dev Server",
@@ -42,43 +42,32 @@
         "kind": "build",
         "isDefault": true
       },
+      "problemMatcher": [],
       "options": {
         "env": {
           "GOOGLE_MAPS_API_KEY": "${GOOGLE_MAPS_API_KEY_LIVE}",
           "RECAPTCHA_V2_SITE_KEY": "${RECAPTCHA_V2_SITE_KEY_LIVE}"
         }
       },
-      "problemMatcher": [],
       "detail": "Builds the project using Vite"
     },
     {
       "label": "Preview Build",
       "type": "npm",
       "script": "preview",
       "group": {
-        "kind": "test",
+        "kind": "build",
         "isDefault": true
       },
       "problemMatcher": [],
       "detail": "Previews the built project using Vite"
     },
-    {
-      "label": "Preview Build On Host",
-      "type": "npm",
-      "script": "host",
-      "group": {
-        "kind": "test",
-        "isDefault": true
-      },
-      "problemMatcher": [],
-      "detail": "Previews the built project using Vite on a spceific exposed host"
-    },
     {
       "label": "Run Tests",
       "type": "npm",
       "script": "test",
       "group": {
-        "kind": "test",
+        "kind": "build",
         "isDefault": true
       },
       "problemMatcher": [],
@@ -89,7 +78,7 @@
       "type": "npm",
       "script": "lint",
       "group": {
-        "kind": "test",
+        "kind": "build",
         "isDefault": true
       },
       "problemMatcher": [],
@@ -100,7 +89,7 @@
       "type": "npm",
       "script": "audit",
       "group": {
-        "kind": "test",
+        "kind": "build",
         "isDefault": true
       },
       "problemMatcher": [],
@@ -111,7 +100,7 @@
       "type": "shell",
       "command": "npm audit",
       "group": {
-        "kind": "test",
+        "kind": "build",
         "isDefault": true
       },
       "problemMatcher": [],
@@ -122,7 +111,7 @@
       "type": "shell",
       "command": "npm audit fix",
       "group": {
-        "kind": "test",
+        "kind": "build",
         "isDefault": true
       },
       "problemMatcher": [],

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ### Table of Contents
 
+- [Version 3.6.6](#version-366---2025-06-01)
 - [Version 3.6.5](#version-365---2025-05-15)
 - [Version 3.6.4](#version-364---2025-05-14)
 - [Version 3.6.3](#version-363---2025-05-14)
@@ -44,6 +45,31 @@
 - [Version 3.0.1](#version-301---2024-08-27)
 - [Version 3.0.0](#version-300---2024-08-18)
 
+### [Version 3.6.6](https://github.com/tahoni/hpsc-web-vite/releases/tag/version-3.6.5) - _2025-06-01_
+
+Created a sitemap of the website.
+
+#### Enhancements and Updates
+
+- Added a sitemap builder to the `builder` directory that generates a sitemap and logs it to the console.
+- Created a new model class for the sitemap builder to use.
+- Split off the page info needed by the sitemap builder into a separate TypeScript file.
+- Added metadata to the pages for the sitemap, like date last updated.
+
+#### General Technical Changes
+
+- Generated a `sitemap.xml` file with all the pages of the website.
+- Referred to this file in the `robots.txt` file.
+
+#### Dependencies
+
+- Added the `sitemap` dependency.
+- Added the `tsx` dependency as a dev dependency.
+
+#### Changes by
+
+@tahoni
+
 ### [Version 3.6.5](https://github.com/tahoni/hpsc-web-vite/releases/tag/version-3.6.5) - _2025-05-15_
 
 Changed the canonical URL to just the domain name, since it is served like that

RELEASE_NOTES.md

@@ -2,21 +2,26 @@
 
 ## Release Notes
 
-### Version 3.6.5 - _2025-05-15_
+### Version 3.6.6 - _2025-06-01_
 
-Changed the canonical URL to just the domain name, since it is served like that
-by the web server.
-Fixed all the pages being redirected to the home page on refresh.
+Created a sitemap of the website.
 
 #### Enhancements and Updates
 
-- Updated the canonical URL in `index.html` to just [https://hpsc.co.za](https://hpsc.co.za),
-  without the `www` prefix.
+- Added a sitemap builder to the `builder` directory that generates a sitemap and logs it to the console.
+- Created a new model class for the sitemap builder to use.
+- Split off the page info needed by the sitemap builder into a separate TypeScript file.
+- Added metadata to the pages for the sitemap, like date last updated.
 
 #### General Technical Changes
 
-- Removed the permanent redirect (HTTP status 301) from the `.htaccess` rules
-  that was redirecting all pages to the home page on manual refresh.
+- Generated a `sitemap.xml` file with all the pages of the website.
+- Referred to this file in the `robots.txt` file.
+
+#### Dependencies
+
+- Added the `sitemap` dependency.
+- Added the `tsx` dependency as a dev dependency.
 
 #### Changes by
 

builders/RoutesSitemap.ts

@@ -0,0 +1,37 @@
+import { SitemapStream, streamToPromise } from "sitemap";
+import { Readable } from "stream";
+import { SitemapMapping } from "../src/model/SitemapMapping";
+import { coreRoutes } from "../src/config/BaseRoutes";
+import { baseUrl } from "../src/constants/AppConstants";
+
+export const generateRoutesSitemap = async () => {
+  // An array with your links
+  const links: SitemapMapping[] = coreRoutes.map((route) => {
+    const priority: number = route.name === "Home" ? 1.0 : 0.5;
+    return new SitemapMapping({
+      url: route.path,
+      priority: priority,
+      lastmod: route.dateUpdated,
+    });
+  });
+
+  // Create a stream to write to
+  const stream = new SitemapStream({
+    hostname: baseUrl,
+    lastmodDateOnly: true,
+  });
+
+  // Return a promise that resolves with your XML string
+  const data = await streamToPromise(Readable.from(links).pipe(stream));
+  return data.toString();
+};
+
+generateRoutesSitemap().then((xml) => {
+  console.log(xml);
+});
+// This code builds a sitemap using the sitemap package and streams the links into it.
+// The sitemap is then converted to a string and logged to the console.
+// You can modify the links array to include your own URLs and their properties.
+// Make sure to replace "https://..." with your actual hostname.
+// You can also adjust the changefreq and priority as needed for your sitemap.
+// This code is a basic example and can be expanded to include more complex logic or additional features as needed.