npm - @sockethub/platform-feeds - Versions diffs - 4.0.0-alpha.10 → 4.0.0-alpha.12 - Mend

@sockethub/platform-feeds 4.0.0-alpha.10 → 4.0.0-alpha.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "@sockethub/platform-feeds",
   "description": "A sockethub platform module implementing RSS/Atom functionality",
-  "version": "4.0.0-alpha.10",
+  "version": "4.0.0-alpha.12",
   "type": "module",
   "private": false,
   "author": "Nick Jennings <nick@silverbucket.net>",
@@ -43,7 +43,8 @@
   "homepage": "https://github.com/sockethub/sockethub/tree/master/packages/platform-feeds",
   "scripts": {
     "build": "bun build src/index.ts --outdir dist --target node --format esm --sourcemap=external",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "clean:deps": "rm -rf node_modules"
   },
   "dependencies": {
     "html-tags": "^3.3.1",
@@ -51,17 +52,16 @@
     "podparse": "^1.6.0"
   },
   "devDependencies": {
-    "@sockethub/schemas": "^3.0.0-alpha.10",
-    "@types/bun": "latest",
-    "debug": "^4.4.3"
+    "@sockethub/schemas": "^3.0.0-alpha.12",
+    "@types/bun": "latest"
   },
   "peerDependencies": {
-    "@sockethub/server": "5.0.0-alpha.10"
+    "@sockethub/server": "5.0.0-alpha.12"
   },
   "peerDependenciesMeta": {
     "@sockethub/server": {
       "optional": true
     }
   },
-  "gitHead": "8e1abf116b2a6b57d33c6e1a4af9143870517bae"
+  "gitHead": "f039dab3c3f67cbbf204476fc397532e973f82a8"
 }

package/src/index.test.ts CHANGED Viewed

@@ -2,13 +2,17 @@ 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")
+            log: {
+                error: () => {},
+                warn: () => {},
+                info: () => {},
+                debug: () => {},
+            }
         } as unknown as PlatformSession);
         platform.makeRequest = (
@@ -120,14 +124,14 @@ describe("platform-feeds", () => {
             expect(err).toBeNull();
             // Validate required ASCollection properties
-            expect(results).toHaveProperty("context");
+            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(Array.isArray(results["@context"])).toBe(true);
             expect(typeof results.summary).toBe("string");
             expect(typeof results.totalItems).toBe("number");
             expect(Array.isArray(results.items)).toBe(true);

package/src/index.ts CHANGED Viewed

@@ -16,9 +16,6 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  */
-import htmlTags from "html-tags";
-import getPodcastFromFeed, { type Episode, type Meta } from "podparse";
 import type {
     ActivityStream,
     Logger,
@@ -28,6 +25,9 @@ import type {
     PlatformSchemaStruct,
     PlatformSession,
 } from "@sockethub/schemas";
+import { buildCanonicalContext } from "@sockethub/schemas";
+import htmlTags from "html-tags";
+import getPodcastFromFeed, { type Episode, type Meta } from "podparse";
 import PlatformSchema from "./schema.js";
 import {
@@ -39,6 +39,7 @@ import {
 } from "./types.js";
 const MAX_NOTE_LENGTH = 256;
+const FEEDS_CONTEXT = buildCanonicalContext(PlatformSchema.contextUrl);
 const basic = /\s?<!doctype html>|(<html\b[^>]*>|<body\b[^>]*>|<x-[^>]+>)+/i;
 const full = new RegExp(
@@ -70,7 +71,7 @@ function isHtml(s: string): boolean {
  */
 export default class Feeds implements PlatformInterface {
     id: string;
-    debug: Logger;
+    private readonly log: Logger;
     config: PlatformConfig = {
         persist: false,
         connectTimeoutMs: 5000,
@@ -81,13 +82,20 @@ export default class Feeds implements PlatformInterface {
      * @param session - a unique session object for this platform instance
      */
     constructor(session: PlatformSession) {
-        this.debug = session.debug;
+        this.log = session.log;
     }
     get schema(): PlatformSchemaStruct {
         return PlatformSchema;
     }
+    /**
+     * Stateless platforms are always ready to handle jobs.
+     */
+    isInitialized(): boolean {
+        return true;
+    }
     /**
      * Fetch feeds from specified source. Upon completion, it will send back a
      * response to the original request with a complete ActivityStreams Collection
@@ -99,7 +107,7 @@ export default class Feeds implements PlatformInterface {
      * @example
      * Request:
      *  {
-     *    context: "feeds",
+     *    "@context": ["https://www.w3.org/ns/activitystreams", "https://sockethub.org/ns/context/v1.jsonld", "https://sockethub.org/ns/context/platform/feeds/v1.jsonld"],
      *    type: "fetch",
      *    actor: {
      *      id: 'http://blog.example.com/rss',
@@ -169,7 +177,7 @@ export default class Feeds implements PlatformInterface {
             .then((results) => {
                 return done(null, {
                     id: job.id || null,
-                    context: "feeds",
+                    "@context": FEEDS_CONTEXT,
                     type: "collection",
                     summary:
                         results.length > 0 && results[0]?.actor?.name
@@ -193,9 +201,7 @@ export default class Feeds implements PlatformInterface {
     }
     private async makeRequest(url: string): Promise<string> {
-        const opts = {
-            signal: undefined,
-        };
+        const opts: RequestInit = {};
         if (this.config.connectTimeoutMs) {
             opts.signal = AbortSignal.timeout(this.config.connectTimeoutMs);
         }
@@ -209,7 +215,7 @@ export default class Feeds implements PlatformInterface {
         url: string,
         id: string,
     ): Promise<Array<PlatformFeedsActivityStream>> {
-        this.debug(`fetching ${url}`);
+        this.log.debug(`fetching ${url}`);
         const res = await this.makeRequest(url);
         const feed = getPodcastFromFeed(res);
         const actor = buildFeedChannel(url, feed.meta);
@@ -221,7 +227,7 @@ export default class Feeds implements PlatformInterface {
             article.object = buildFeedItem(item as FeedItem);
             articles.push(article);
         }
-        this.debug(`fetched ${articles.length} articles`);
+        this.log.debug(`fetched ${articles.length} articles`);
         return articles;
     }
 }
@@ -260,7 +266,7 @@ function buildFeedStruct(
     actor: PlatformFeedsActivityActor,
 ): PlatformFeedsActivityStream {
     return {
-        context: ASFeedType.FEEDS,
+        "@context": FEEDS_CONTEXT,
         actor: actor,
         type: "post",
     };

package/src/schema.ts CHANGED Viewed

@@ -3,6 +3,9 @@ import packageJSON from "../package.json" with { type: "json" };
 export default {
     name: "feeds",
     version: packageJSON.version,
+    contextUrl: "https://sockethub.org/ns/context/platform/feeds/v1.jsonld",
+    contextVersion: "1",
+    schemaVersion: "1",
     messages: {
         required: ["type"],
         properties: {
@@ -18,5 +21,17 @@ export default {
                 ],
             },
         },
+        definitions: {
+            objectTypes: {
+                "feed-parameters-date": {
+                    type: "object",
+                    additionalProperties: true,
+                },
+                "feed-parameters-url": {
+                    type: "object",
+                    additionalProperties: true,
+                },
+            },
+        },
     },
 };

package/src/types.ts CHANGED Viewed

@@ -1,10 +1,9 @@
-import type { Author } from "podparse";
 import type {
     ActivityActor,
     ActivityObject,
     ActivityStream,
 } from "@sockethub/schemas";
+import type { Author } from "podparse";
 export enum ASFeedType {
     FEED_CHANNEL = "feed",
@@ -30,7 +29,7 @@ export interface PlatformFeedsActivityActor extends ActivityActor {
 export interface PlatformFeedsActivityStream extends ActivityStream {
     id?: string;
-    context: ASFeedType.FEEDS;
+    "@context": Array<string>;
     actor: PlatformFeedsActivityActor;
     type: string;
     object?: PlatformFeedsActivityObject;