@adobe/helix-html-pipeline 6.29.12 → 6.30.1

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [6.30.1](https://github.com/adobe/helix-html-pipeline/compare/v6.30.0...v6.30.1) (2026-08-17)
+
+
+### Bug Fixes
+
+* **sitemap-index:** static version in code, dynamic version in content ([#1125](https://github.com/adobe/helix-html-pipeline/issues/1125)) ([5c76a06](https://github.com/adobe/helix-html-pipeline/commit/5c76a060b3ff5a1c198c565f256b3ee7a5bbbc0b))
+
+# [6.30.0](https://github.com/adobe/helix-html-pipeline/compare/v6.29.12...v6.30.0) (2026-08-14)
+
+
+### Features
+
+* add support for sitemap index generation ([#1124](https://github.com/adobe/helix-html-pipeline/issues/1124)) ([f5bc462](https://github.com/adobe/helix-html-pipeline/commit/f5bc4624ac53df576bcdc22ea8e29359e36ed620))
+
 ## [6.29.12](https://github.com/adobe/helix-html-pipeline/compare/v6.29.11...v6.29.12) (2026-08-12)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-html-pipeline",
-  "version": "6.29.12",
+  "version": "6.30.1",
   "description": "Helix HTML Pipeline",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/index.js

@@ -14,6 +14,7 @@ export * from './json-pipe.js';
 export * from './options-pipe.js';
 export * from './robots-pipe.js';
 export * from './sitemap-pipe.js';
+export * from './sitemap-index-pipe.js';
 export * from './PipelineContent.js';
 export * from './PipelineRequest.js';
 export * from './PipelineResponse.js';

package/src/sitemap-index-pipe.js

@@ -0,0 +1,117 @@
+/*
+ * Copyright 2024 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.
+ */
+import escape from 'lodash.escape';
+import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
+import fetchContent from './steps/fetch-content.js';
+import renderCode from './steps/render-code.js';
+import setXSurrogateKeyHeader from './steps/set-x-surrogate-key-header.js';
+import setCustomResponseHeaders from './steps/set-custom-response-headers.js';
+import { PipelineStatusError } from './PipelineStatusError.js';
+import { PipelineResponse } from './PipelineResponse.js';
+import initConfig from './steps/init-config.js';
+import { extractLastModified, recordLastModified, setLastModified } from './utils/last-modified.js';
+
+async function generateSitemapIndex(state) {
+  const {
+    owner, repo, ref, partition,
+    previewHost, liveHost, prodHost, config,
+  } = state;
+
+  const { sitemap } = config;
+  if (!sitemap?.index) {
+    throw new PipelineStatusError(404, 'No sitemap index defined in configuration');
+  }
+  const host = partition === 'preview'
+    ? (previewHost || `${ref}--${repo}--${owner}.aem.page`)
+    : (prodHost || liveHost || `${ref}--${repo}--${owner}.aem.live`);
+  const loc = (path) => (path.startsWith('/') ? `https://${host}${escape(path)}` : path);
+  const xml = [
+    '<?xml version="1.0" encoding="utf-8"?>',
+    '<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">',
+    ...sitemap.index.map((index) => `  <sitemap>
+    <loc>${loc(index)}</loc>
+  </sitemap>`),
+    '</sitemapindex>',
+    '',
+  ].join('\n');
+  return new PipelineResponse(xml, {
+    status: 200,
+    headers: {
+      'content-type': 'application/xml; charset=utf-8',
+      'last-modified': sitemap.lastModified,
+    },
+  });
+}
+
+export async function sitemapIndexPipe(state, req) {
+  const { log } = state;
+  state.type = 'sitemap-index';
+
+  if (state.info?.path !== '/sitemap-index.xml') {
+    // this should not happen as it would mean that the caller used the wrong route. so we respond
+    // with a 500 to indicate that something is wrong.
+    return new PipelineResponse('', {
+      status: 500,
+      headers: {
+        'x-error': 'invalid route',
+      },
+    });
+  }
+
+  /** @type PipelineResponse */
+  const res = new PipelineResponse('', {
+    headers: {
+      'content-type': 'text/plain; charset=utf-8',
+    },
+  });
+
+  try {
+    await initConfig(state, req, res);
+
+    // fetch sitemap-index.xml
+    state.timer?.update('content-fetch');
+    state.content.sourceBus = 'code';
+    await fetchContent(state, req, res);
+    if (res.status === 404) {
+      state.content.sourceBus = 'content';
+      const ret = await generateSitemapIndex(state);
+      if (ret.status === 200) {
+        res.status = 200;
+        recordLastModified(state, res, 'content', extractLastModified(ret.headers));
+        delete res.error;
+        state.content.data = ret.body;
+      }
+    }
+    if (res.error) {
+      // if content loading produced an error, we're done.
+      throw new PipelineStatusError(res.status, res.error);
+    }
+
+    state.timer?.update('serialize');
+    await renderCode(state, req, res);
+    setLastModified(state, res);
+    await setCustomResponseHeaders(state, req, res);
+    await setXSurrogateKeyHeader(state, req, res);
+  } catch (e) {
+    res.error = e.message;
+    res.status = e.code || 500;
+
+    const level = res.status >= 500 ? 'error' : 'info';
+    log[level](`pipeline status: ${res.status} ${res.error}`);
+    res.headers.set('x-error', cleanupHeaderValue(res.error));
+    if (res.status < 500) {
+      await setCustomResponseHeaders(state, req, res);
+      await setXSurrogateKeyHeader(state, req, res);
+    }
+  }
+  return res;
+}

package/src/steps/set-x-surrogate-key-header.js

@@ -57,9 +57,11 @@ export async function computeCodePathKey(state) {
 export default async function setXSurrogateKeyHeader(state, req, res) {
   const {
     contentBusId, owner, repo, ref, partition,
+    info: { path },
   } = state;
 
   const isCode = state.content.sourceBus === 'code';
+  const purgeMetadataAndHead = !['/sitemap.xml', '/sitemap-index.xml'].includes(path);
 
   // provide either (prefixed) preview or (unprefixed) live content keys
   const contentKeyPrefix = partition === 'preview' ? 'p_' : '';
@@ -70,8 +72,10 @@ export default async function setXSurrogateKeyHeader(state, req, res) {
     keys.push(`${ref}--${repo}--${owner}_code`);
   } else {
     keys.push(`${contentKeyPrefix}${hash}`);
-    keys.push(`${contentKeyPrefix}${contentBusId}_metadata`);
-    keys.push(`${ref}--${repo}--${owner}_head`);
+    if (purgeMetadataAndHead) {
+      keys.push(`${contentKeyPrefix}${contentBusId}_metadata`);
+      keys.push(`${ref}--${repo}--${owner}_head`);
+    }
     keys.push(`${contentKeyPrefix}${contentBusId}`);
   }
   // for folder-mapped resources, we also need to include the surrogate key of the mapped metadata