@tmlmobilidade/rss 20260331.1620.53

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { type CreateRssFeedOptions, type RssRawItem } from './types/index.js';
+export declare function createRssFeed(rawItems: RssRawItem[], options: CreateRssFeedOptions): string;

package/dist/index.js

@@ -0,0 +1,29 @@
+/* * */
+import { rssFeedXml, rssItemXml } from './utils/index.js';
+/* * */
+export function createRssFeed(rawItems, options) {
+    //
+    //
+    // A. Create XML items
+    const itemsXml = rawItems.map(item => rssItemXml({
+        description: item.summary || item.description || '',
+        link: item.link || '',
+        publishDate: item.publishDate || item.publish_start_date || item.created_at ? new Date(item.publishDate || item.publish_start_date || item.created_at).toUTCString() : undefined,
+        title: item.title || '',
+    })).join('\n');
+    //
+    // B. Create and return XML feed
+    const now = new Date().toUTCString();
+    return rssFeedXml(itemsXml, {
+        channelCopyright: options.copyright,
+        channelDescription: options.description,
+        channelDocs: 'https://www.rssboard.org/rss-specification',
+        channelGenerator: '@tmlmobilidade/rss',
+        channelLanguage: 'pt-pt',
+        channelLastBuildDate: now,
+        channelLink: options.link,
+        channelPubDate: now,
+        channelTitle: options.title,
+    });
+    //
+}

package/dist/types/feed.types.d.ts

@@ -0,0 +1,19 @@
+export interface RssRawItem {
+    _id?: string;
+    created_at?: number | string;
+    description?: null | string;
+    id?: string;
+    info_url?: null | string;
+    link?: null | string;
+    publish_start_date?: null | number;
+    publishDate?: null | string;
+    slug?: null | string;
+    summary?: null | string;
+    title?: null | string;
+}
+export interface CreateRssFeedOptions {
+    copyright: string;
+    description: string;
+    link: string;
+    title: string;
+}

package/dist/types/feed.types.js

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './feed.types.js';

package/dist/types/index.js

@@ -0,0 +1 @@
+export * from './feed.types.js';

package/dist/utils/escape-xml.d.ts

@@ -0,0 +1 @@
+export declare function escapeXml(value: null | string | undefined): string;

package/dist/utils/escape-xml.js

@@ -0,0 +1,12 @@
+/* * */
+export function escapeXml(value) {
+    if (!value)
+        return '';
+    return value
+        .replace(/&/g, '&')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        .replace(/"/g, '&quot;')
+        .replace(/'/g, '&apos;');
+}
+/* * */

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './escape-xml.js';
+export * from './rss-feed-xml.js';
+export * from './rss-item-xml.js';

package/dist/utils/index.js

@@ -0,0 +1,3 @@
+export * from './escape-xml.js';
+export * from './rss-feed-xml.js';
+export * from './rss-item-xml.js';

package/dist/utils/rss-feed-xml.d.ts

@@ -0,0 +1,13 @@
+interface RssChannelOptions {
+    channelCopyright: string;
+    channelDescription: string;
+    channelDocs: string;
+    channelGenerator: string;
+    channelLanguage: string;
+    channelLastBuildDate: string;
+    channelLink: string;
+    channelPubDate: string;
+    channelTitle: string;
+}
+export declare function rssFeedXml(itemsXml: string, channelOptions: RssChannelOptions): string;
+export {};

package/dist/utils/rss-feed-xml.js

@@ -0,0 +1,22 @@
+/* * */
+import { escapeXml } from './escape-xml.js';
+export function rssFeedXml(itemsXml, channelOptions) {
+    return [
+        '<?xml version="1.0" encoding="UTF-8"?>',
+        '<rss version="2.0">',
+        '<channel>',
+        `<title>${escapeXml(channelOptions.channelTitle)}</title>`,
+        `<link>${escapeXml(channelOptions.channelLink)}</link>`,
+        `<description>${escapeXml(channelOptions.channelDescription)}</description>`,
+        `<language>${escapeXml(channelOptions.channelLanguage)}</language>`,
+        `<lastBuildDate>${escapeXml(channelOptions.channelLastBuildDate)}</lastBuildDate>`,
+        `<generator>${escapeXml(channelOptions.channelGenerator)}</generator>`,
+        `<docs>${escapeXml(channelOptions.channelDocs)}</docs>`,
+        `<pubDate>${escapeXml(channelOptions.channelPubDate)}</pubDate>`,
+        `<copyright>${escapeXml(channelOptions.channelCopyright)}</copyright>`,
+        itemsXml,
+        '</channel>',
+        '</rss>',
+    ].join('\n');
+}
+/* * */

package/dist/utils/rss-item-xml.d.ts

@@ -0,0 +1,2 @@
+import { type RssRawItem } from '../types/feed.types.js';
+export declare function rssItemXml(item: RssRawItem): string;

package/dist/utils/rss-item-xml.js

@@ -0,0 +1,15 @@
+/* * */
+import { escapeXml } from './escape-xml.js';
+/* * */
+export function rssItemXml(item) {
+    return [
+        '<item>',
+        `<title>${escapeXml(item.title)}</title>`,
+        `<link>${escapeXml(item.link || '')}</link>`,
+        `<guid isPermaLink="true">${escapeXml(item.link || '')}</guid>`,
+        item.publishDate ? `<pubDate>${escapeXml(item.publishDate)}</pubDate>` : '',
+        `<description>${escapeXml(item.description)}</description>`,
+        '</item>',
+    ].filter(Boolean).join('\n');
+}
+/* * */

package/package.json

@@ -0,0 +1,49 @@
+{
+	"name": "@tmlmobilidade/rss",
+	"version": "20260331.1620.53",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://go.tmlmobilidade.pt",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/go/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/go.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"go"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint ./src/ && tsc --noEmit",
+		"lint:fix": "eslint ./src/ --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"dependencies": {
+		"@tmlmobilidade/dates": "*"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/tsconfig": "*",
+		"@tmlmobilidade/types": "*",
+		"@types/node": "25.5.0",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.0",
+		"typescript": "5.9.3"
+	}
+}