@sockethub/platform-feeds 4.0.0-alpha.8 → 4.0.0-beta.0

package/src/index.test.ts

@@ -1,139 +0,0 @@
-import { beforeEach, describe, expect, it } from "bun:test";
-import { RSSFeed} from "./index.test.data";
-import Feeds from "./index";
-import { ASCollection, PlatformSession } from "@sockethub/schemas";
-import debug from "debug";
-
-describe("platform-feeds", () => {
-    let platform;
-    beforeEach(() => {
-        platform = new Feeds({
-            debug: debug("sockethub:platform:feeds")
-        } as unknown as PlatformSession);
-
-        platform.makeRequest = (
-            url: string,
-        ): Promise<string> => {
-            return Promise.resolve(RSSFeed);
-        };
-    });
-
-    it("fetches expected feed", () => {
-        platform.fetch({
-            id: "an id",
-            actor: {
-                id: "some url"
-            }
-        }, (err, results: ASCollection) => {
-            expect(results['totalItems']).toEqual(20);
-            expect(results['items'][5]['object']).toEqual({
-                type: "article",
-                title: "Sockethub 3.x",
-                id: "https://sockethub.org/news/2019-09-26-3x.html",
-                brief: undefined,
-                content: "<p>Sockethub 3.0 has been released and includes a lot of improvements focusing mainly on XMPP and IRC, additionally a ton of internal improvements. Ongoing releases tracked on the <a href=\"https://github.com/sockethub/sockethub/releases\">Github page</a>. </p>",
-                contentType: "html",
-                url: "https://sockethub.org/news/2019-09-26-3x.html",
-                published: "2019-09-26T00:00:00.000Z",
-                updated: undefined,
-                datenum: 1569456000000,
-                tags: undefined,
-                media: undefined,
-                source: undefined,
-            })
-        })
-    })
-
-    it("handles empty feed gracefully", () => {
-        // Mock empty feed
-        platform.makeRequest = (): Promise<string> => {
-            return Promise.resolve('<rss><channel><title>Empty Feed</title></channel></rss>');
-        };
-
-        platform.fetch({
-            id: "empty-feed-id",
-            actor: {
-                id: "http://example.com/empty.xml"
-            }
-        }, (err, results: ASCollection) => {
-            expect(err).toBeNull();
-            expect(results.type).toEqual("collection");
-            expect(results.totalItems).toEqual(0);
-            expect(results.items).toEqual([]);
-            expect(results.summary).toEqual("Unknown Feed");
-        })
-    })
-
-    it("handles feed with no actor name", () => {
-        // Mock feed with no title/name but proper structure
-        platform.makeRequest = (): Promise<string> => {
-            return Promise.resolve(`
-                <rss>
-                    <channel>
-                        <item>
-                            <title>Test Item</title>
-                            <description>Test content</description>
-                            <link>http://example.com/item</link>
-                            <pubDate>Thu, 01 Jan 2024 00:00:00 GMT</pubDate>
-                        </item>
-                    </channel>
-                </rss>
-            `);
-        };
-
-        platform.fetch({
-            id: "no-name-feed-id", 
-            actor: {
-                id: "http://example.com/noname.xml"
-            }
-        }, (err, results: ASCollection) => {
-            expect(err).toBeNull();
-            // When no title is provided, buildFeedChannel falls back to URL
-            expect(results.summary).toEqual("http://example.com/noname.xml");
-        })
-    })
-
-    it("handles network errors properly", () => {
-        platform.makeRequest = (): Promise<string> => {
-            return Promise.reject(new Error("Network timeout"));
-        };
-
-        platform.fetch({
-            id: "error-test-id",
-            actor: {
-                id: "http://example.com/timeout.xml"
-            }
-        }, (err, results: ASCollection) => {
-            expect(err).toBeInstanceOf(Error);
-            expect(err.message).toEqual("Network timeout");
-            expect(results).toBeUndefined();
-        })
-    })
-
-    it("validates collection structure matches ASCollection interface", () => {
-        platform.fetch({
-            id: "validation-test-id",
-            actor: {
-                id: "some url"
-            }
-        }, (err, results: ASCollection) => {
-            expect(err).toBeNull();
-            
-            // Validate required ASCollection properties
-            expect(results).toHaveProperty("context");
-            expect(results).toHaveProperty("type", "collection");
-            expect(results).toHaveProperty("summary");
-            expect(results).toHaveProperty("totalItems");
-            expect(results).toHaveProperty("items");
-            
-            // Validate types
-            expect(typeof results.context).toBe("string");
-            expect(typeof results.summary).toBe("string");
-            expect(typeof results.totalItems).toBe("number");
-            expect(Array.isArray(results.items)).toBe(true);
-            
-            // Validate collection consistency
-            expect(results.items.length).toEqual(results.totalItems);
-        })
-    })
-})

package/src/index.ts

@@ -1,281 +0,0 @@
-/**
- * This is a platform for Sockethub implementing Atom/RSS fetching functionality.
- *
- * Developed by Nick Jennings (https://github.com/silverbucket)
- *
- * Sockethub is licensed under the LGPLv3.
- * See the LICENSE file for details.
- *
- * The latest version of this module can be found here:
- *   git://github.com/sockethub/sockethub.git
- *
- * For more information about Sockethub visit http://sockethub.org/.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
- */
-
-import htmlTags from "html-tags";
-import getPodcastFromFeed, { type Episode, type Meta } from "podparse";
-
-import type {
-    ActivityStream,
-    Logger,
-    PlatformCallback,
-    PlatformConfig,
-    PlatformInterface,
-    PlatformSchemaStruct,
-    PlatformSession,
-} from "@sockethub/schemas";
-
-import PlatformSchema from "./schema.js";
-import {
-    ASFeedType,
-    ASObjectType,
-    type PlatformFeedsActivityActor,
-    type PlatformFeedsActivityObject,
-    type PlatformFeedsActivityStream,
-} from "./types.js";
-
-const MAX_NOTE_LENGTH = 256;
-
-const basic = /\s?<!doctype html>|(<html\b[^>]*>|<body\b[^>]*>|<x-[^>]+>)+/i;
-const full = new RegExp(
-    htmlTags.map((tag) => `<${tag}\\b[^>]*>`).join("|"),
-    "i",
-);
-
-function isHtml(s: string): boolean {
-    // limit it to a reasonable length to improve performance.
-    const limitedString = s.trim().slice(0, 1000);
-    return basic.test(limitedString) || full.test(s);
-}
-
-/**
- * Class: Feeds
- *
- * Handles all actions related to fetching feeds.
- *
- * Current supported feed types:
- *
- * - RSS (1 & 2)
- *
- * - Atom
- *
- * Uses the `podparse` module as a base tool fetching feeds.
- *
- * https://github.com/Tombarr/podcast-feed-parser
- *
- */
-export default class Feeds implements PlatformInterface {
-    id: string;
-    debug: Logger;
-    config: PlatformConfig = {
-        persist: false,
-        connectTimeoutMs: 5000,
-    };
-
-    /**
-     * @constructor
-     * @param session - a unique session object for this platform instance
-     */
-    constructor(session: PlatformSession) {
-        this.debug = session.debug;
-    }
-
-    get schema(): PlatformSchemaStruct {
-        return PlatformSchema;
-    }
-
-    /**
-     * Fetch feeds from specified source. Upon completion, it will send back a
-     * response to the original request with a complete ActivityStreams Collection
-     * containing all feed items and metadata.
-     *
-     * @param job - Activity streams object containing job data with actor.id as feed URL
-     * @param done - Callback function that receives (error, ASCollection)
-     *
-     * @example
-     * Request:
-     *  {
-     *    context: "feeds",
-     *    type: "fetch",
-     *    actor: {
-     *      id: 'http://blog.example.com/rss',
-     *      type: "feed"
-     *    }
-     *  }
-     *
-     *
-     *  // Without any parameters specified, the platform will return most
-     *  // recent 10 articles fetched from the feed.
-     *
-     *  // Example of the resulting JSON AS Object:
-     *
-     *   {
-     *     context: 'feeds',
-     *     type: 'collection',
-     *     summary: 'Best Feed Inc.'
-     *     totalItems: 10,
-     *     items: [
-     *       {
-     *         context: 'feeds',
-     *         type: 'post',
-     *         actor: {
-     *           type: 'feed',
-     *           name: 'Best Feed Inc.',
-     *           id: 'http://blog.example.com/rss',
-     *           description: 'Where the best feed comes to be the best',
-     *           image: {
-     *             width: '144',
-     *             height: '144',
-     *             url: 'http://blog.example.com/images/bestfeed.jpg',
-     *           }
-     *           favicon: 'http://blog.example.com/favicon.ico',
-     *           link: 'http://blog.example.com',
-     *           categories: ['best', 'feed', 'aminals'],
-     *           language: 'en',
-     *           author: 'John Doe'
-     *         },
-     *         object: {
-     *           id: "http://blog.example.com/articles/about-stuff"
-     *           type: 'article',
-     *           title: 'About stuff...',
-     *           url: "http://blog.example.com/articles/about-stuff"
-     *           date: "2013-05-28T12:00:00.000Z",
-     *           datenum: 1369742400000,
-     *           brief: "Brief synopsis of stuff...",
-     *           content: "Once upon a time...",
-     *           contentType: "text",
-     *           media: [
-     *             {
-     *               length: '13908973',
-     *               type: 'audio/mpeg',
-     *               url: 'http://blog.example.com/media/thing.mpg'
-     *             }
-     *           ]
-     *           tags: ['foo', 'bar']
-     *         }
-     *       },
-     *       ...
-     *     ]
-     *   }
-     *
-     */
-    fetch(job: ActivityStream, done: PlatformCallback) {
-        // ready to execute job
-        this.fetchFeed(job.actor.id, job.id)
-            .then((results) => {
-                return done(null, {
-                    id: job.id || null,
-                    context: "feeds",
-                    type: "collection",
-                    summary:
-                        results.length > 0 && results[0]?.actor?.name
-                            ? results[0].actor.name
-                            : "Unknown Feed",
-                    totalItems: results.length,
-                    items: results,
-                });
-            })
-            .catch(done);
-    }
-
-    /**
-     * Cleanup method called when platform instance is being shut down.
-     * Currently, no cleanup required for feeds platform.
-     *
-     * @param done - Callback function to signal completion
-     */
-    cleanup(done: PlatformCallback) {
-        done();
-    }
-
-    private async makeRequest(url: string): Promise<string> {
-        const opts = {
-            signal: undefined,
-        };
-        if (this.config.connectTimeoutMs) {
-            opts.signal = AbortSignal.timeout(this.config.connectTimeoutMs);
-        }
-        const res = await fetch(url, opts);
-        return await res.text();
-    }
-
-    // fetches the articles from a feed, adding them to an array
-    // for processing
-    private async fetchFeed(
-        url: string,
-        id: string,
-    ): Promise<Array<PlatformFeedsActivityStream>> {
-        this.debug(`fetching ${url}`);
-        const res = await this.makeRequest(url);
-        const feed = getPodcastFromFeed(res);
-        const actor = buildFeedChannel(url, feed.meta);
-        const articles = [];
-
-        for (const item of feed.episodes) {
-            const article = buildFeedStruct(actor);
-            article.id = id;
-            article.object = buildFeedItem(item as FeedItem);
-            articles.push(article);
-        }
-        this.debug(`fetched ${articles.length} articles`);
-        return articles;
-    }
-}
-
-interface FeedItem extends Episode {
-    meta: Meta;
-    date: string;
-    categories: Array<string>;
-    media: Array<unknown>;
-    source: string;
-}
-
-function buildFeedItem(item: FeedItem): PlatformFeedsActivityObject {
-    const dateNum = Date.parse(item.pubDate.toString()) || 0;
-    return {
-        type:
-            item.description.length > MAX_NOTE_LENGTH
-                ? ASObjectType.ARTICLE
-                : ASObjectType.NOTE,
-        title: item.title,
-        id: item.link || `${item.meta.link}#${dateNum}`,
-        brief: item.description === item.summary ? undefined : item.summary,
-        content: item.description,
-        contentType: isHtml(item.description || "") ? "html" : "text",
-        url: item.link || item.meta.link,
-        published: item.pubDate,
-        updated: item.pubDate === item.date ? undefined : item.date,
-        datenum: dateNum,
-        tags: item.categories,
-        media: item.media,
-        source: item.source,
-    };
-}
-
-function buildFeedStruct(
-    actor: PlatformFeedsActivityActor,
-): PlatformFeedsActivityStream {
-    return {
-        context: ASFeedType.FEEDS,
-        actor: actor,
-        type: "post",
-    };
-}
-
-function buildFeedChannel(url: string, meta: Meta): PlatformFeedsActivityActor {
-    return {
-        id: url,
-        type: ASFeedType.FEED_CHANNEL,
-        name: meta.title ? meta.title : meta.link ? meta.link : url,
-        link: meta.link || url,
-        description: meta.description ? meta.description : undefined,
-        image: meta.image ? meta.image : undefined,
-        categories: meta.category ? meta.category : [],
-        language: meta.language ? meta.language : undefined,
-        author: meta.author ? meta.author : undefined,
-    };
-}

package/src/schema.ts

@@ -1,22 +0,0 @@
-import packageJSON from "../package.json" with { type: "json" };
-
-export default {
-    name: "feeds",
-    version: packageJSON.version,
-    messages: {
-        required: ["type"],
-        properties: {
-            type: {
-                type: "string",
-                enum: ["fetch"],
-            },
-            object: {
-                type: "object",
-                oneOf: [
-                    { $ref: "#/definitions/objectTypes/feed-parameters-date" },
-                    { $ref: "#/definitions/objectTypes/feed-parameters-url" },
-                ],
-            },
-        },
-    },
-};