@adobe/helix-shared-config 8.0.0 → 8.1.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [@adobe/helix-shared-config-v8.1.0](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config-v8.0.0...@adobe/helix-shared-config-v8.1.0) (2022-06-16)
+
+
+### Bug Fixes
+
+* **sitemap:** create a separate context for each sitemap ([a27e80b](https://github.com/adobe/helix-shared/commit/a27e80be6a437d8e18071b5f0adcbcfbb52e5ab1))
+* **sitemap:** use h1 ([25a4f97](https://github.com/adobe/helix-shared/commit/25a4f97229cd5f140c95f67200c002ecfba57662))
+
+
+### Features
+
+* **sitemap:** allow resetting the fetch context ([df861d8](https://github.com/adobe/helix-shared/commit/df861d88c564b1a0cad2800b531a0444f586e728))
+* **sitemap:** propagate resets ([41f77ab](https://github.com/adobe/helix-shared/commit/41f77abbd960073c2dff2575762efc4988783bc3))
+* **sitemaps:** add `getContents()` and `getXML()` methods to retrieve sitemap content ([ee3fb07](https://github.com/adobe/helix-shared/commit/ee3fb07a170f016c15862623ca3b7e6debca283f))
+
 # [@adobe/helix-shared-config-v8.0.0](https://github.com/adobe/helix-shared/compare/@adobe/helix-shared-config-v7.21.1...@adobe/helix-shared-config-v8.0.0) (2022-06-05)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-shared-config",
-  "version": "8.0.0",
+  "version": "8.1.0",
   "description": "Shared modules of the Helix Project - config",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/SitemapConfig.js

@@ -15,6 +15,7 @@ const { NamedMapHandler } = require('./NamedMapHandler');
 const sitemapConfigSchema = require('./schemas/sitemapconfig.schema.json');
 const sitemapSchema = require('./schemas/sitemap.schema.json');
 const languageSchema = require('./schemas/sitemap-language.schema.json');
+const { SitemapHandler } = require('./SitemapHandler.js');
 
 class SitemapConfig extends SchemaDerivedConfig {
   constructor() {
@@ -26,7 +27,7 @@ class SitemapConfig extends SchemaDerivedConfig {
         '^/sitemaps/.*/languages/.*$': languageSchema,
       },
       handlers: {
-        '^/sitemaps$': NamedMapHandler(),
+        '^/sitemaps$': SitemapHandler(),
         '^/sitemaps/.*/languages$': NamedMapHandler(),
       },
     });
@@ -42,6 +43,10 @@ class SitemapConfig extends SchemaDerivedConfig {
     return this;
   }
 
+  reset() {
+    Object.values(this.sitemaps).forEach((sitemap) => sitemap.reset());
+  }
+
   /**
    * Adds a sitemap definition.
    *

package/src/SitemapHandler.js

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2022 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+const fetchAPI = require('@adobe/helix-fetch');
+const { NamedMapHandler } = require('./NamedMapHandler.js');
+
+const wrap = (sitemap) => {
+  const context = process.env.HELIX_FETCH_FORCE_HTTP1
+    ? fetchAPI.context({
+      alpnProtocols: [fetchAPI.ALPN_HTTP1_1],
+    })
+    : fetchAPI.context();
+  const { fetch } = context;
+
+  if (typeof sitemap === 'object') {
+    return {
+      ...sitemap,
+      reset: () => {
+        context.reset();
+      },
+      getXML: async function getXML() {
+        const res = await fetch(new URL(this.destination, this.origin).href);
+        if (!res.ok) {
+          throw new Error(`Failed to fetch ${this.destination}`);
+        }
+        const xml = await res.text();
+        return xml;
+      },
+      getContents: async function getContents() {
+        const xml = await this.getXML();
+        return (xml.match(/<url>(.*?)<\/url>/gs) || []).reduce((acc, url) => {
+          const urlObj = new URL(url.match(/<loc>(.*?)<\/loc>/)[1], this.origin);
+          const lastmod = new Date(url.match(/<lastmod>(.*?)<\/lastmod>/)[1]);
+          acc.push({
+            url: urlObj,
+            lastmod,
+          });
+          return acc;
+        }, []);
+      },
+
+    };
+  }
+  return sitemap;
+};
+
+const SitemapHandler = (keyname = 'name') => ({
+  get: (target, prop) => wrap(NamedMapHandler(keyname).get(target, prop)),
+});
+exports.SitemapHandler = SitemapHandler;