Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | 27x 4x 2x 20x 213x 20x | // SPDX-FileCopyrightText: 2024-2026 Hack23 AB
// SPDX-License-Identifier: Apache-2.0
/**
* @module Generators/Sitemap/Rss
* @description Generates the per-language RSS feeds. English articles are
* published to `rss.xml`; every other supported language gets its own
* `rss_<lang>.xml` so feed readers subscribe to a single locale instead
* of a mixed-language stream. Each feed carries a localized
* `<title>`/`<description>` channel and items sorted newest-first by
* `pubDate` and tagged with `<dc:language>`.
*
* Extracted from the monolithic `sitemap.ts` so RSS generation can be
* unit-tested in isolation and so any future feed format (Atom,
* JSON-Feed, news-specific RSS) reuses the same item shape and escaping.
*/
import { BASE_URL } from '../../constants/config.js';
import { getLocalizedString, PAGE_TITLES, PAGE_DESCRIPTIONS } from '../../constants/languages.js';
import type { LanguageCode } from '../../types/index.js';
import { escapeXML } from './xml-utils.js';
import { getRssFilename } from '../../templates/sections/rss-discovery.js';
// `getRssFilename` and `buildRssAlternateLink` live in the shared
// `templates/` zone so the aggregator article shell can build feed
// discovery links without an aggregator→generators import. They are
// re-exported here to keep the sitemap RSS module's public surface stable
// (consumed by the `generators/sitemap/index.ts` barrel and unit tests).
export { getRssFilename, buildRssAlternateLink } from '../../templates/sections/rss-discovery.js';
/**
* Single RSS feed entry.
*
* `pubDate` is expected to already be RFC-822 formatted (the same format
* the consuming `<pubDate>` element uses). The wrapper does not reformat
* dates so callers can opt into different cadences (per-day, per-article)
* without surprising rounding.
*/
export interface RssItem {
/** Article title */
readonly title: string;
/** Absolute article URL */
readonly link: string;
/** Plain-text article description */
readonly description: string;
/** RFC-822 publication timestamp */
readonly pubDate: string;
/** ISO 639-1 language code (e.g. `en`, `sv`, `de`) */
readonly lang: string;
}
/**
* Channel-level metadata for an RSS feed (the localized envelope wrapped
* around the `<item>` list).
*/
export interface RssChannel {
/** Localized channel title (shown in feed-reader subscription lists) */
readonly title: string;
/** Localized channel description */
readonly description: string;
/** ISO 639-1 language code for the `<language>` element */
readonly language: string;
/** Absolute URL of this feed document (used in `atom:link rel="self"`) */
readonly selfUrl: string;
}
/**
* English brand channel — also the default envelope used when
* {@link generateRssFeed} is called without an explicit channel. Kept as
* a stable constant so the homepage `rss.xml` channel stays
* byte-identical across runs and refactors.
*/
export const DEFAULT_RSS_CHANNEL: RssChannel = {
title: 'EU Parliament Monitor',
description:
'European Parliament Intelligence Platform — monitoring political activity with systematic transparency.',
language: 'en',
selfUrl: `${BASE_URL}/rss.xml`,
};
/**
* Build the localized channel envelope for a language's feed. English
* reuses {@link DEFAULT_RSS_CHANNEL} (the established brand channel);
* other languages source their title/description from the localized
* page-metadata maps so subscribers see native-language copy.
*
* @param lang - Language code
* @returns Localized {@link RssChannel}
*/
export function buildRssChannel(lang: LanguageCode): RssChannel {
if (lang === 'en') return DEFAULT_RSS_CHANNEL;
return {
title: getLocalizedString(PAGE_TITLES, lang),
description: getLocalizedString(PAGE_DESCRIPTIONS, lang),
language: lang,
selfUrl: `${BASE_URL}/${getRssFilename(lang)}`,
};
}
/**
* Generate an RSS 2.0 XML feed for a single language.
*
* Every item is escaped via {@link escapeXML} so titles or descriptions
* containing `&`/`<`/etc. don't break feed readers. The channel-level
* `<lastBuildDate>` reflects "now" — callers that need deterministic
* output for tests should pass an explicit `buildDate` override.
*
* @param articleInfos - Articles, ideally already sorted newest-first
* @param buildDate - Optional override for the channel-level
* `<lastBuildDate>` (RFC-822 string). Defaults to `new Date().toUTCString()`.
* @param channel - Optional localized channel envelope. Defaults to the
* English {@link DEFAULT_RSS_CHANNEL} so existing call sites stay
* byte-compatible.
* @returns Complete RSS 2.0 XML document
*/
export function generateRssFeed(
articleInfos: readonly RssItem[],
buildDate: string = new Date().toUTCString(),
channel: RssChannel = DEFAULT_RSS_CHANNEL
): string {
const items = articleInfos
.map(
(item) => ` <item>
<title>${escapeXML(item.title)}</title>
<link>${escapeXML(item.link)}</link>
<description>${escapeXML(item.description)}</description>
<pubDate>${item.pubDate}</pubDate>
<guid isPermaLink="true">${escapeXML(item.link)}</guid>
<dc:language>${escapeXML(item.lang)}</dc:language>
</item>`
)
.join('\n');
// REUSE-IgnoreStart
return `<?xml version="1.0" encoding="UTF-8"?>
<!-- SPDX-FileCopyrightText: 2024-2026 Hack23 AB -->
<!-- SPDX-License-Identifier: Apache-2.0 -->
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/">
<channel>
<title>${escapeXML(channel.title)}</title>
<link>${BASE_URL}</link>
<description>${escapeXML(channel.description)}</description>
<language>${escapeXML(channel.language)}</language>
<lastBuildDate>${buildDate}</lastBuildDate>
<atom:link href="${escapeXML(channel.selfUrl)}" rel="self" type="application/rss+xml"/>
${items}
</channel>
</rss>`;
// REUSE-IgnoreEnd
}
|