feedsmith 2.0.0-next.7 → 2.1.0
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 +9 -8
- package/dist/index.cjs +3619 -0
- package/dist/index.d.ts +1016 -19
- package/dist/index.js +3581 -14
- package/package.json +15 -11
- package/dist/common/config.d.ts +0 -24
- package/dist/common/config.js +0 -44
- package/dist/common/parse.d.ts +0 -19
- package/dist/common/parse.js +0 -24
- package/dist/common/types.d.ts +0 -41
- package/dist/common/types.js +0 -1
- package/dist/common/utils.d.ts +0 -37
- package/dist/common/utils.js +0 -477
- package/dist/feeds/atom/common/types.d.ts +0 -103
- package/dist/feeds/atom/common/types.js +0 -2
- package/dist/feeds/atom/detect/index.d.ts +0 -1
- package/dist/feeds/atom/detect/index.js +0 -13
- package/dist/feeds/atom/generate/config.d.ts +0 -2
- package/dist/feeds/atom/generate/config.js +0 -5
- package/dist/feeds/atom/generate/index.d.ts +0 -3
- package/dist/feeds/atom/generate/index.js +0 -10
- package/dist/feeds/atom/generate/utils.d.ts +0 -11
- package/dist/feeds/atom/generate/utils.js +0 -181
- package/dist/feeds/atom/parse/config.d.ts +0 -3
- package/dist/feeds/atom/parse/config.js +0 -68
- package/dist/feeds/atom/parse/index.d.ts +0 -3
- package/dist/feeds/atom/parse/index.js +0 -18
- package/dist/feeds/atom/parse/utils.d.ts +0 -16
- package/dist/feeds/atom/parse/utils.js +0 -206
- package/dist/feeds/json/common/types.d.ts +0 -53
- package/dist/feeds/json/common/types.js +0 -2
- package/dist/feeds/json/detect/index.d.ts +0 -1
- package/dist/feeds/json/detect/index.js +0 -16
- package/dist/feeds/json/generate/index.d.ts +0 -3
- package/dist/feeds/json/generate/index.js +0 -4
- package/dist/feeds/json/generate/utils.d.ts +0 -1971
- package/dist/feeds/json/generate/utils.js +0 -17
- package/dist/feeds/json/parse/index.d.ts +0 -3
- package/dist/feeds/json/parse/index.js +0 -13
- package/dist/feeds/json/parse/utils.d.ts +0 -9
- package/dist/feeds/json/parse/utils.js +0 -114
- package/dist/feeds/rdf/common/types.d.ts +0 -48
- package/dist/feeds/rdf/common/types.js +0 -2
- package/dist/feeds/rdf/detect/index.d.ts +0 -1
- package/dist/feeds/rdf/detect/index.js +0 -14
- package/dist/feeds/rdf/parse/config.d.ts +0 -3
- package/dist/feeds/rdf/parse/config.js +0 -22
- package/dist/feeds/rdf/parse/index.d.ts +0 -3
- package/dist/feeds/rdf/parse/index.js +0 -18
- package/dist/feeds/rdf/parse/utils.d.ts +0 -10
- package/dist/feeds/rdf/parse/utils.js +0 -90
- package/dist/feeds/rss/common/types.d.ts +0 -114
- package/dist/feeds/rss/common/types.js +0 -2
- package/dist/feeds/rss/detect/index.d.ts +0 -1
- package/dist/feeds/rss/detect/index.js +0 -13
- package/dist/feeds/rss/generate/config.d.ts +0 -2
- package/dist/feeds/rss/generate/config.js +0 -5
- package/dist/feeds/rss/generate/index.d.ts +0 -3
- package/dist/feeds/rss/generate/index.js +0 -10
- package/dist/feeds/rss/generate/utils.d.ts +0 -14
- package/dist/feeds/rss/generate/utils.js +0 -184
- package/dist/feeds/rss/parse/config.d.ts +0 -3
- package/dist/feeds/rss/parse/config.js +0 -49
- package/dist/feeds/rss/parse/index.d.ts +0 -3
- package/dist/feeds/rss/parse/index.js +0 -18
- package/dist/feeds/rss/parse/utils.d.ts +0 -15
- package/dist/feeds/rss/parse/utils.js +0 -166
- package/dist/namespaces/atom/common/types.d.ts +0 -4
- package/dist/namespaces/atom/common/types.js +0 -2
- package/dist/namespaces/atom/generate/utils.d.ts +0 -4
- package/dist/namespaces/atom/generate/utils.js +0 -7
- package/dist/namespaces/atom/parse/utils.d.ts +0 -4
- package/dist/namespaces/atom/parse/utils.js +0 -7
- package/dist/namespaces/content/common/types.d.ts +0 -3
- package/dist/namespaces/content/common/types.js +0 -2
- package/dist/namespaces/content/generate/utils.d.ts +0 -3
- package/dist/namespaces/content/generate/utils.js +0 -10
- package/dist/namespaces/content/parse/utils.d.ts +0 -3
- package/dist/namespaces/content/parse/utils.js +0 -10
- package/dist/namespaces/dc/common/types.d.ts +0 -18
- package/dist/namespaces/dc/common/types.js +0 -2
- package/dist/namespaces/dc/generate/utils.d.ts +0 -3
- package/dist/namespaces/dc/generate/utils.js +0 -24
- package/dist/namespaces/dc/parse/utils.d.ts +0 -3
- package/dist/namespaces/dc/parse/utils.js +0 -24
- package/dist/namespaces/dcterms/common/types.d.ts +0 -58
- package/dist/namespaces/dcterms/common/types.js +0 -2
- package/dist/namespaces/dcterms/generate/utils.d.ts +0 -3
- package/dist/namespaces/dcterms/generate/utils.js +0 -64
- package/dist/namespaces/dcterms/parse/utils.d.ts +0 -3
- package/dist/namespaces/dcterms/parse/utils.js +0 -64
- package/dist/namespaces/georss/common/types.d.ts +0 -26
- package/dist/namespaces/georss/common/types.js +0 -2
- package/dist/namespaces/georss/generate/utils.d.ts +0 -11
- package/dist/namespaces/georss/generate/utils.js +0 -60
- package/dist/namespaces/georss/parse/utils.d.ts +0 -11
- package/dist/namespaces/georss/parse/utils.js +0 -68
- package/dist/namespaces/itunes/common/types.d.ts +0 -44
- package/dist/namespaces/itunes/common/types.js +0 -2
- package/dist/namespaces/itunes/generate/utils.d.ts +0 -7
- package/dist/namespaces/itunes/generate/utils.js +0 -70
- package/dist/namespaces/itunes/parse/utils.d.ts +0 -9
- package/dist/namespaces/itunes/parse/utils.js +0 -99
- package/dist/namespaces/media/common/types.d.ts +0 -172
- package/dist/namespaces/media/common/types.js +0 -2
- package/dist/namespaces/media/generate/utils.d.ts +0 -33
- package/dist/namespaces/media/generate/utils.js +0 -350
- package/dist/namespaces/media/parse/utils.d.ts +0 -35
- package/dist/namespaces/media/parse/utils.js +0 -344
- package/dist/namespaces/podcast/common/types.d.ts +0 -182
- package/dist/namespaces/podcast/common/types.js +0 -2
- package/dist/namespaces/podcast/generate/utils.d.ts +0 -32
- package/dist/namespaces/podcast/generate/utils.js +0 -362
- package/dist/namespaces/podcast/parse/utils.d.ts +0 -31
- package/dist/namespaces/podcast/parse/utils.js +0 -330
- package/dist/namespaces/slash/common/types.d.ts +0 -7
- package/dist/namespaces/slash/common/types.js +0 -2
- package/dist/namespaces/slash/generate/utils.d.ts +0 -3
- package/dist/namespaces/slash/generate/utils.js +0 -13
- package/dist/namespaces/slash/parse/utils.d.ts +0 -4
- package/dist/namespaces/slash/parse/utils.js +0 -16
- package/dist/namespaces/source/common/types.d.ts +0 -32
- package/dist/namespaces/source/common/types.js +0 -2
- package/dist/namespaces/source/generate/utils.d.ts +0 -8
- package/dist/namespaces/source/generate/utils.js +0 -68
- package/dist/namespaces/source/parse/utils.d.ts +0 -8
- package/dist/namespaces/source/parse/utils.js +0 -69
- package/dist/namespaces/sy/common/types.d.ts +0 -6
- package/dist/namespaces/sy/common/types.js +0 -2
- package/dist/namespaces/sy/generate/utils.d.ts +0 -3
- package/dist/namespaces/sy/generate/utils.js +0 -12
- package/dist/namespaces/sy/parse/utils.d.ts +0 -3
- package/dist/namespaces/sy/parse/utils.js +0 -12
- package/dist/namespaces/thr/common/types.d.ts +0 -15
- package/dist/namespaces/thr/common/types.js +0 -2
- package/dist/namespaces/thr/generate/utils.d.ts +0 -5
- package/dist/namespaces/thr/generate/utils.js +0 -33
- package/dist/namespaces/thr/parse/utils.d.ts +0 -5
- package/dist/namespaces/thr/parse/utils.js +0 -33
- package/dist/namespaces/wfw/common/types.d.ts +0 -4
- package/dist/namespaces/wfw/common/types.js +0 -2
- package/dist/namespaces/wfw/generate/utils.d.ts +0 -3
- package/dist/namespaces/wfw/generate/utils.js +0 -11
- package/dist/namespaces/wfw/parse/utils.d.ts +0 -3
- package/dist/namespaces/wfw/parse/utils.js +0 -11
- package/dist/namespaces/yt/common/types.d.ts +0 -8
- package/dist/namespaces/yt/common/types.js +0 -2
- package/dist/namespaces/yt/generate/utils.d.ts +0 -4
- package/dist/namespaces/yt/generate/utils.js +0 -21
- package/dist/namespaces/yt/parse/utils.d.ts +0 -4
- package/dist/namespaces/yt/parse/utils.js +0 -21
- package/dist/opml/common/types.d.ts +0 -39
- package/dist/opml/common/types.js +0 -2
- package/dist/opml/generate/config.d.ts +0 -2
- package/dist/opml/generate/config.js +0 -5
- package/dist/opml/generate/index.d.ts +0 -3
- package/dist/opml/generate/index.js +0 -10
- package/dist/opml/generate/utils.d.ts +0 -6
- package/dist/opml/generate/utils.js +0 -66
- package/dist/opml/parse/config.d.ts +0 -3
- package/dist/opml/parse/config.js +0 -22
- package/dist/opml/parse/index.d.ts +0 -3
- package/dist/opml/parse/index.js +0 -10
- package/dist/opml/parse/utils.d.ts +0 -6
- package/dist/opml/parse/utils.js +0 -63
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
[](https://www.npmjs.com/package/feedsmith)
|
|
6
6
|
[](https://github.com/macieklamberski/feedsmith/blob/main/LICENSE)
|
|
7
7
|
|
|
8
|
-
Fast, all‑in‑one JavaScript parser and generator for RSS, Atom,
|
|
8
|
+
Fast, all‑in‑one JavaScript parser and generator for RSS, Atom, RDF, and JSON Feed, with support for popular namespaces and OPML files.
|
|
9
9
|
|
|
10
10
|
Feedsmith offers universal and format‑specific parsers that maintain the original feed structure in a clean, object-oriented format while intelligently normalizing legacy elements. Access all feed data without compromising simplicity.
|
|
11
11
|
|
|
@@ -40,7 +40,8 @@ Feedsmith offers universal and format‑specific parsers that maintain the origi
|
|
|
40
40
|
* **Well-tested** 🔬 — Comprehensive test suite with over 2000 tests and 99% code coverage.
|
|
41
41
|
|
|
42
42
|
### Compatibility
|
|
43
|
-
* Works in Node.js and modern browsers.
|
|
43
|
+
* Works in Node.js 14.0.0+ and modern browsers.
|
|
44
|
+
* Supports both CommonJS and ES modules.
|
|
44
45
|
* Works with plain JavaScript, you don't need to use TypeScript.
|
|
45
46
|
|
|
46
47
|
## Supported Formats
|
|
@@ -59,8 +60,8 @@ Feedsmith aims to fully support all major feed formats and namespaces in complet
|
|
|
59
60
|
|--------|----------|---------|------------|
|
|
60
61
|
| [RSS](http://cyber.law.harvard.edu/rss/rss.html) | 0.9x, 2.0 | ✅ | ✅ |
|
|
61
62
|
| [Atom](https://tools.ietf.org/html/rfc4287) | 0.3, 1.0 | ✅ | ✅ |
|
|
62
|
-
| [JSON Feed](https://jsonfeed.org) | 1.0, 1.1 | ✅ | ✅ |
|
|
63
63
|
| [RDF](https://web.resource.org/rss/1.0/spec) | 0.9, 1.0 | ✅ | ⏳ |
|
|
64
|
+
| [JSON Feed](https://jsonfeed.org) | 1.0, 1.1 | ✅ | ✅ |
|
|
64
65
|
|
|
65
66
|
### Namespaces
|
|
66
67
|
|
|
@@ -73,6 +74,7 @@ Feedsmith aims to fully support all major feed formats and namespaces in complet
|
|
|
73
74
|
| [Slash](http://purl.org/rss/1.0/modules/slash/) | `<slash:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
74
75
|
| [iTunes](http://www.itunes.com/dtds/podcast-1.0.dtd) | `<itunes:*>` | RSS, Atom | ✅ | ✅ |
|
|
75
76
|
| [Podcast](https://podcastindex.org/namespace/1.0) | `<podcast:*>` | RSS | ✅ | ✅ |
|
|
77
|
+
| [Podlove Simple Chapters](http://podlove.org/simple-chapters) | `<psc:*>` | RSS, Atom | ✅ | ✅ |
|
|
76
78
|
| [Media RSS](http://search.yahoo.com/mrss/) | `<media:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
77
79
|
| [GeoRSS-Simple](http://www.georss.org/georss) | `<georss:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
78
80
|
| [Atom Threading](https://www.ietf.org/rfc/rfc4685.txt) | `<thr:*>` | RSS, Atom | ✅ | ✅ |
|
|
@@ -108,7 +110,7 @@ The simplest way to parse any feed is to use the universal `parseFeed` function:
|
|
|
108
110
|
```typescript
|
|
109
111
|
import { parseFeed } from 'feedsmith'
|
|
110
112
|
|
|
111
|
-
// Works with RSS, Atom,
|
|
113
|
+
// Works with RSS, Atom, RDF, and JSON Feed
|
|
112
114
|
const { format, feed } = parseFeed(feedContent)
|
|
113
115
|
|
|
114
116
|
console.log('Feed format:', format) // rss, atom, json, rdf
|
|
@@ -119,7 +121,7 @@ if (format === 'rss') {
|
|
|
119
121
|
}
|
|
120
122
|
```
|
|
121
123
|
|
|
122
|
-
###
|
|
124
|
+
### Parse Specific Feed Formats
|
|
123
125
|
|
|
124
126
|
If you know the format in advance, you can use the format-specific parsers:
|
|
125
127
|
|
|
@@ -132,10 +134,10 @@ import {
|
|
|
132
134
|
} from 'feedsmith'
|
|
133
135
|
|
|
134
136
|
// Parse specific formats
|
|
135
|
-
const atomFeed = parseAtomFeed('atom content')
|
|
136
|
-
const jsonFeed = parseJsonFeed('json content')
|
|
137
137
|
const rssFeed = parseRssFeed('rss content')
|
|
138
|
+
const atomFeed = parseAtomFeed('atom content')
|
|
138
139
|
const rdfFeed = parseRdfFeed('rdf content')
|
|
140
|
+
const jsonFeed = parseJsonFeed('json content')
|
|
139
141
|
|
|
140
142
|
// Access typed data
|
|
141
143
|
rssFeed.title
|
|
@@ -177,7 +179,6 @@ console.log(rss) // Complete RSS XML
|
|
|
177
179
|
// You can also generate other formats:
|
|
178
180
|
// - generateAtomFeed() for Atom feeds
|
|
179
181
|
// - generateJsonFeed() for JSON feeds
|
|
180
|
-
// - generateRdfFeed() for RDF feeds
|
|
181
182
|
// - generateOpml() for OPML files
|
|
182
183
|
```
|
|
183
184
|
|