@sockethub/platform-feeds 3.0.0-alpha.4 → 4.0.0-alpha.11
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.
- package/README.md +60 -7
- package/dist/index.js +1988 -0
- package/dist/index.js.map +27 -0
- package/package.json +32 -17
- package/src/index.test.data.ts +299 -0
- package/src/index.test.ts +143 -0
- package/src/index.ts +288 -0
- package/src/schema.ts +22 -0
- package/src/types.ts +53 -0
- package/API.md +0 -197
- package/index.js +0 -333
package/README.md
CHANGED
|
@@ -1,15 +1,68 @@
|
|
|
1
1
|
# @sockethub/platform-feeds
|
|
2
2
|
|
|
3
|
-
A Sockethub platform module
|
|
3
|
+
A Sockethub platform module for fetching and parsing RSS and Atom feeds.
|
|
4
4
|
|
|
5
5
|
## About
|
|
6
6
|
|
|
7
|
-
This
|
|
8
|
-
|
|
7
|
+
This platform fetches RSS and Atom feeds from URLs and converts feed entries into
|
|
8
|
+
ActivityStreams objects. It handles various feed formats and provides structured data for
|
|
9
|
+
web applications to consume feed content.
|
|
9
10
|
|
|
10
|
-
## Implemented (`@type`)
|
|
11
|
+
## Implemented Verbs (`@type`)
|
|
11
12
|
|
|
12
|
-
|
|
13
|
+
* **fetch** - Retrieve and parse an RSS or Atom feed
|
|
13
14
|
|
|
14
|
-
##
|
|
15
|
-
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
### Request Format
|
|
18
|
+
|
|
19
|
+
```json
|
|
20
|
+
{
|
|
21
|
+
"@type": "fetch",
|
|
22
|
+
"context": "feeds",
|
|
23
|
+
"actor": {
|
|
24
|
+
"@id": "https://example.com/feed.xml"
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Response Format
|
|
30
|
+
|
|
31
|
+
Returns an ActivityStreams Collection with feed entries:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"@type": "Collection",
|
|
36
|
+
"context": "feeds",
|
|
37
|
+
"totalItems": 10,
|
|
38
|
+
"items": [
|
|
39
|
+
{
|
|
40
|
+
"@type": "Create",
|
|
41
|
+
"actor": {
|
|
42
|
+
"@id": "https://example.com/feed.xml",
|
|
43
|
+
"name": "Example Blog"
|
|
44
|
+
},
|
|
45
|
+
"object": {
|
|
46
|
+
"@type": "Article",
|
|
47
|
+
"name": "Blog Post Title",
|
|
48
|
+
"content": "Post content...",
|
|
49
|
+
"url": "https://example.com/post/1",
|
|
50
|
+
"published": "2023-01-01T12:00:00Z"
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
]
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Supported Feed Formats
|
|
58
|
+
|
|
59
|
+
* **RSS 2.0**: Standard RSS feeds
|
|
60
|
+
* **Atom 1.0**: Atom syndication format
|
|
61
|
+
* **RSS 1.0/RDF**: RDF-based RSS feeds
|
|
62
|
+
|
|
63
|
+
## Use Cases
|
|
64
|
+
|
|
65
|
+
* **Content aggregation**: Collect posts from multiple blogs and news sites
|
|
66
|
+
* **Feed readers**: Build web-based feed reading applications
|
|
67
|
+
* **Content monitoring**: Track updates from RSS/Atom feeds
|
|
68
|
+
* **Data integration**: Import feed content into other systems
|