@tmlmobilidade/rss 20260406.1418.25 → 20260407.1655.55

package/dist/components/RSSFeedItem/index.d.ts

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

package/dist/components/RSSFeedItem/index.js

@@ -0,0 +1,30 @@
+/* * */
+import { buildContentEncoded } from '../../utils/build-content-encoded.js';
+import { escapeXml } from '../../utils/escape-xml.js';
+import { normalizeImageInputs } from '../../utils/normalize-image-inputs.js';
+/* * */
+export function rssFeedItem(item) {
+    //
+    //
+    // A. Transform Data
+    const enclosuresXml = normalizeImageInputs(item.images ?? []).map((image) => {
+        const lengthAttr = image.length != null ? ` length="${String(image.length)}"` : '';
+        const typeAttr = image.type ? ` type="${escapeXml(image.type)}"` : '';
+        return `<enclosure url="${escapeXml(image.url)}"${lengthAttr}${typeAttr} />`;
+    });
+    //
+    // B. Return Result
+    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>`,
+        buildContentEncoded(item),
+        enclosuresXml.length ? enclosuresXml.join('\n') : '',
+        '</item>',
+    ].filter(Boolean).join('\n');
+    //
+}
+/* * */

package/dist/{utils/rss-feed-xml.d.ts → components/RssXML/index.d.ts}

@@ -2,6 +2,7 @@ interface RssChannelOptions {
     channelCopyright: string;
     channelDescription: string;
     channelDocs: string;
+    channelFeedSelfUrl?: string;
     channelGenerator: string;
     channelLanguage: string;
     channelLastBuildDate: string;
@@ -9,5 +10,5 @@ interface RssChannelOptions {
     channelPubDate: string;
     channelTitle: string;
 }
-export declare function rssFeedXml(itemsXml: string, channelOptions: RssChannelOptions): string;
+export declare function rssFeed(itemsXml: string, channelOptions: RssChannelOptions): string;
 export {};

package/dist/{utils/rss-feed-xml.js → components/RssXML/index.js}

@@ -1,11 +1,17 @@
 /* * */
-import { escapeXml } from './escape-xml.js';
-export function rssFeedXml(itemsXml, channelOptions) {
+import { escapeXml } from '../../utils/escape-xml.js';
+/* * */
+export function rssFeed(itemsXml, channelOptions) {
+    //
+    //
+    // A. Setup Variables
+    const rssOpenTag = '<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom" xmlns:content="http://purl.org/rss/1.0/modules/content/">';
+    //
+    // B. Return Result
     return [
         '<?xml version="1.0" encoding="UTF-8"?>',
-        '<rss version="2.0">',
+        rssOpenTag,
         '<channel>',
-        `<title>${escapeXml(channelOptions.channelTitle)}</title>`,
         `<link>${escapeXml(channelOptions.channelLink)}</link>`,
         `<description>${escapeXml(channelOptions.channelDescription)}</description>`,
         `<language>${escapeXml(channelOptions.channelLanguage)}</language>`,
@@ -14,9 +20,13 @@ export function rssFeedXml(itemsXml, channelOptions) {
         `<docs>${escapeXml(channelOptions.channelDocs)}</docs>`,
         `<pubDate>${escapeXml(channelOptions.channelPubDate)}</pubDate>`,
         `<copyright>${escapeXml(channelOptions.channelCopyright)}</copyright>`,
+        channelOptions.channelFeedSelfUrl
+            ? `<atom:link href="${escapeXml(channelOptions.channelFeedSelfUrl)}" rel="self" type="application/rss+xml" />`
+            : '',
         itemsXml,
         '</channel>',
         '</rss>',
-    ].join('\n');
+    ].filter(Boolean).join('\n');
+    //
 }
 /* * */

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,23 +1,28 @@
 /* * */
-import { rssFeedXml, rssItemXml } from './utils/index.js';
+import { rssFeedItem } from './components/RSSFeedItem/index.js';
+import { rssFeed } from './components/RssXML/index.js';
 /* * */
 export function createRssFeed(rawItems, options) {
     //
     //
     // A. Create XML items
-    const itemsXml = rawItems.map(item => rssItemXml({
+    const itemsXml = rawItems.map(item => rssFeedItem({
+        contentHtml: item.contentHtml,
         description: item.summary || item.description || '',
+        images: item.images,
         link: item.link || '',
+        linkLabel: item.linkLabel,
         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, {
+    return rssFeed(itemsXml, {
         channelCopyright: options.copyright,
         channelDescription: options.description,
         channelDocs: 'https://www.rssboard.org/rss-specification',
+        channelFeedSelfUrl: options.feedSelfUrl,
         channelGenerator: '@tmlmobilidade/rss',
         channelLanguage: 'pt-pt',
         channelLastBuildDate: now,

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

@@ -1,10 +1,17 @@
+export interface RssRawImageInput {
+    alt?: null | string;
+    length?: null | number;
+    type?: null | string;
+    url: string;
+}
 export interface RssRawItem {
     _id?: string;
+    contentHtml?: null | string;
     created_at?: number | string;
     description?: null | string;
-    id?: string;
-    info_url?: null | string;
+    images?: Array<RssRawImageInput>;
     link?: null | string;
+    linkLabel?: null | string;
     publish_start_date?: null | number;
     publishDate?: null | string;
     slug?: null | string;
@@ -14,6 +21,7 @@ export interface RssRawItem {
 export interface CreateRssFeedOptions {
     copyright: string;
     description: string;
+    feedSelfUrl?: string;
     link: string;
     title: string;
 }

package/dist/types/feed.types.js

@@ -1 +1,3 @@
+/* * */
 export {};
+/* * */

package/dist/types/index.d.ts

@@ -1 +1,2 @@
 export * from './feed.types.js';
+export * from './normalized-rss-image.js';

package/dist/types/index.js

@@ -1 +1,2 @@
 export * from './feed.types.js';
+export * from './normalized-rss-image.js';

package/dist/types/normalized-rss-image.d.ts

@@ -0,0 +1,6 @@
+export interface NormalizedRssImage {
+    alt?: string;
+    length?: number;
+    type?: string;
+    url: string;
+}

package/dist/types/normalized-rss-image.js

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

package/dist/utils/build-content-encoded.d.ts

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

package/dist/utils/build-content-encoded.js

@@ -0,0 +1,37 @@
+/* * */
+import { escapeXml } from './escape-xml.js';
+import { normalizeImageInputs } from './normalize-image-inputs.js';
+/* * */
+export function buildContentEncoded(item) {
+    //
+    //
+    // A. Setup Variables
+    const parts = [];
+    const bodyHtml = escapeXml(item.description).replace(/\n/g, '<br />');
+    //
+    // B. Transform Data
+    const cdataSafe = (fragment) => {
+        return fragment.replace(/\]\]>/g, ']]]]><![CDATA[>');
+    };
+    if (item.contentHtml) {
+        return `<content:encoded><![CDATA[${cdataSafe(item.contentHtml)}]]></content:encoded>`;
+    }
+    if (item.description) {
+        parts.push(`<div>${bodyHtml}</div>`);
+    }
+    for (const image of normalizeImageInputs(item.images ?? [])) {
+        const alt = image.alt ? escapeXml(image.alt) : '';
+        parts.push(`<p>`
+            + `<img src="${escapeXml(image.url)}" alt="${alt}" />`
+            + `</p>`);
+    }
+    if (item.link) {
+        parts.push(`<p>`
+            + `<a href="${escapeXml(item.link)}">${escapeXml(item.linkLabel ?? 'Ler artigo completo')}</a>`
+            + `</p>`);
+    }
+    //
+    // C. Return Result
+    return `<content:encoded><![CDATA[${cdataSafe(parts.join('\n'))}]]></content:encoded>`;
+    //
+}

package/dist/utils/normalize-image-inputs.d.ts

@@ -0,0 +1,3 @@
+import { type RssRawImageInput } from '../types/feed.types.js';
+import { NormalizedRssImage } from '../types/normalized-rss-image.js';
+export declare function normalizeImageInputs(images: RssRawImageInput[]): NormalizedRssImage[];

package/dist/utils/normalize-image-inputs.js

@@ -0,0 +1,27 @@
+/* * */
+/* * */
+export function normalizeImageInputs(images) {
+    //
+    //
+    // A. Setup Variables
+    const normalizedImages = [];
+    //
+    // B. Transform Data
+    for (const image of images ?? []) {
+        const url = image.url?.trim() ?? '';
+        const normalizedImage = { url };
+        if (!url)
+            continue;
+        if (image.alt)
+            normalizedImage.alt = image.alt;
+        if (image.type)
+            normalizedImage.type = image.type;
+        if (image.length != null && Number.isFinite(image.length))
+            normalizedImage.length = Math.floor(image.length);
+        normalizedImages.push(normalizedImage);
+    }
+    //
+    // C. Return Result
+    return normalizedImages;
+    //
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/rss",
-	"version": "20260406.1418.25",
+	"version": "20260407.1655.55",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"

package/dist/utils/index.d.ts

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

package/dist/utils/index.js

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

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

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

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

@@ -1,15 +0,0 @@
-/* * */
-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');
-}
-/* * */