feat: support extension in sitemap location

adobe · Jun 5, 2024 · ed2f2b8 · ed2f2b8
1 parent 914459a
commit ed2f2b8
Show file tree

Hide file tree

Showing 8 changed files with 97 additions and 5 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/helix-shared-config/src/schemas/sitemap-language.schema.json b/packages/helix-shared-config/src/schemas/sitemap-language.schema.json
@@ -55,6 +55,14 @@
         "/en/{path}",
         "/german/{path}"
       ]
+    },
+    "extension": {
+      "type": "string",
+      "title": "Location extension",
+      "description": "Extension to append to every location generated for this sitemap. Default is empty",
+      "examples": [
+        ".html"
+      ]
     }
   },
   "required": [

diff --git a/packages/helix-shared-config/src/schemas/sitemap.schema.json b/packages/helix-shared-config/src/schemas/sitemap.schema.json
@@ -46,6 +46,14 @@
       "additionalProperties": {
         "$ref": "https://ns.adobe.com/helix/shared/sitemap-language"
       }
+    },
+    "extension": {
+      "type": "string",
+      "title": "Location extension",
+      "description": "Extension to append to every location generated for this sitemap. Default is empty",
+      "examples": [
+        ".html"
+      ]
     }
   },
   "required": []

diff --git a/packages/helix-shared-config/test/sitemapconfigs.test.js b/packages/helix-shared-config/test/sitemapconfigs.test.js
@@ -27,6 +27,11 @@ const tests = [
     config: 'simple.yaml',
     result: 'simple.json',
   },
+  {
+    title: 'loads a simple example with extension',
+    config: 'simple-extension.yaml',
+    result: 'simple-extension.json',
+  },
   {
     title: 'loads an example with multiple languages',
     config: 'multilang.yaml',

diff --git a/packages/helix-shared-config/test/specs/sitemapconfigs/multilang-extension.json b/packages/helix-shared-config/test/specs/sitemapconfigs/multilang-extension.json
@@ -0,0 +1,28 @@
+{
+  "sitemaps": {
+    "multilang": {
+      "origin": "https://www.example.com",
+      "languages": {
+        "en": {
+          "source": "/en/query-index.json",
+          "destination": "/sitemap-en.xml",
+          "hreflang": "en"
+        },
+        "fr": {
+          "source": "/fr/query-index.json",
+          "destination": "/sitemap-fr.xml",
+          "hreflang": "fr",
+          "alternate": "/fr/{path}",
+          "extension": ".html"
+        },
+        "la": {
+          "source": "/la/query-index.json",
+          "destination": "/sitemap-la.xml",
+          "hreflang": ["es-VE","es-SV","es-PA"],
+          "alternate": "/la/{path}"
+        }
+      }
+    }
+  },
+  "version": 1
+}
diff --git a/packages/helix-shared-config/test/specs/sitemapconfigs/multilang-extension.yaml b/packages/helix-shared-config/test/specs/sitemapconfigs/multilang-extension.yaml
@@ -0,0 +1,24 @@
+version: 1
+
+sitemaps:
+  multilang:
+    origin: https://www.example.com
+    languages:
+      en:
+        source: /en/query-index.json
+        destination: /sitemap-en.xml
+        hreflang: en
+      fr:
+        source: /fr/query-index.json
+        destination: /sitemap-fr.xml
+        hreflang: fr
+        alternate: /fr/{path}
+        extension: .html
+      la:
+        source: /la/query-index.json
+        destination: /sitemap-la.xml
+        hreflang:
+          - es-VE
+          - es-SV
+          - es-PA
+        alternate: /la/{path}
diff --git a/packages/helix-shared-config/test/specs/sitemapconfigs/simple-extension.json b/packages/helix-shared-config/test/specs/sitemapconfigs/simple-extension.json
@@ -0,0 +1,11 @@
+{
+  "sitemaps": {
+    "simple": {
+      "origin": "https://www.example.com",
+      "source": "/query-index.json",
+      "destination": "/sitemap-en.xml",
+      "extension": ".html"
+    }
+  },
+  "version": 1
+}
diff --git a/packages/helix-shared-config/test/specs/sitemapconfigs/simple-extension.yaml b/packages/helix-shared-config/test/specs/sitemapconfigs/simple-extension.yaml
@@ -0,0 +1,8 @@
+version: 1
+
+sitemaps:
+  simple:
+    origin: https://www.example.com
+    source: /query-index.json
+    destination: /sitemap-en.xml
+    extension: .html