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.
Files changed (165) hide show
  1. package/README.md +9 -8
  2. package/dist/index.cjs +3619 -0
  3. package/dist/index.d.ts +1016 -19
  4. package/dist/index.js +3581 -14
  5. package/package.json +15 -11
  6. package/dist/common/config.d.ts +0 -24
  7. package/dist/common/config.js +0 -44
  8. package/dist/common/parse.d.ts +0 -19
  9. package/dist/common/parse.js +0 -24
  10. package/dist/common/types.d.ts +0 -41
  11. package/dist/common/types.js +0 -1
  12. package/dist/common/utils.d.ts +0 -37
  13. package/dist/common/utils.js +0 -477
  14. package/dist/feeds/atom/common/types.d.ts +0 -103
  15. package/dist/feeds/atom/common/types.js +0 -2
  16. package/dist/feeds/atom/detect/index.d.ts +0 -1
  17. package/dist/feeds/atom/detect/index.js +0 -13
  18. package/dist/feeds/atom/generate/config.d.ts +0 -2
  19. package/dist/feeds/atom/generate/config.js +0 -5
  20. package/dist/feeds/atom/generate/index.d.ts +0 -3
  21. package/dist/feeds/atom/generate/index.js +0 -10
  22. package/dist/feeds/atom/generate/utils.d.ts +0 -11
  23. package/dist/feeds/atom/generate/utils.js +0 -181
  24. package/dist/feeds/atom/parse/config.d.ts +0 -3
  25. package/dist/feeds/atom/parse/config.js +0 -68
  26. package/dist/feeds/atom/parse/index.d.ts +0 -3
  27. package/dist/feeds/atom/parse/index.js +0 -18
  28. package/dist/feeds/atom/parse/utils.d.ts +0 -16
  29. package/dist/feeds/atom/parse/utils.js +0 -206
  30. package/dist/feeds/json/common/types.d.ts +0 -53
  31. package/dist/feeds/json/common/types.js +0 -2
  32. package/dist/feeds/json/detect/index.d.ts +0 -1
  33. package/dist/feeds/json/detect/index.js +0 -16
  34. package/dist/feeds/json/generate/index.d.ts +0 -3
  35. package/dist/feeds/json/generate/index.js +0 -4
  36. package/dist/feeds/json/generate/utils.d.ts +0 -1971
  37. package/dist/feeds/json/generate/utils.js +0 -17
  38. package/dist/feeds/json/parse/index.d.ts +0 -3
  39. package/dist/feeds/json/parse/index.js +0 -13
  40. package/dist/feeds/json/parse/utils.d.ts +0 -9
  41. package/dist/feeds/json/parse/utils.js +0 -114
  42. package/dist/feeds/rdf/common/types.d.ts +0 -48
  43. package/dist/feeds/rdf/common/types.js +0 -2
  44. package/dist/feeds/rdf/detect/index.d.ts +0 -1
  45. package/dist/feeds/rdf/detect/index.js +0 -14
  46. package/dist/feeds/rdf/parse/config.d.ts +0 -3
  47. package/dist/feeds/rdf/parse/config.js +0 -22
  48. package/dist/feeds/rdf/parse/index.d.ts +0 -3
  49. package/dist/feeds/rdf/parse/index.js +0 -18
  50. package/dist/feeds/rdf/parse/utils.d.ts +0 -10
  51. package/dist/feeds/rdf/parse/utils.js +0 -90
  52. package/dist/feeds/rss/common/types.d.ts +0 -114
  53. package/dist/feeds/rss/common/types.js +0 -2
  54. package/dist/feeds/rss/detect/index.d.ts +0 -1
  55. package/dist/feeds/rss/detect/index.js +0 -13
  56. package/dist/feeds/rss/generate/config.d.ts +0 -2
  57. package/dist/feeds/rss/generate/config.js +0 -5
  58. package/dist/feeds/rss/generate/index.d.ts +0 -3
  59. package/dist/feeds/rss/generate/index.js +0 -10
  60. package/dist/feeds/rss/generate/utils.d.ts +0 -14
  61. package/dist/feeds/rss/generate/utils.js +0 -184
  62. package/dist/feeds/rss/parse/config.d.ts +0 -3
  63. package/dist/feeds/rss/parse/config.js +0 -49
  64. package/dist/feeds/rss/parse/index.d.ts +0 -3
  65. package/dist/feeds/rss/parse/index.js +0 -18
  66. package/dist/feeds/rss/parse/utils.d.ts +0 -15
  67. package/dist/feeds/rss/parse/utils.js +0 -166
  68. package/dist/namespaces/atom/common/types.d.ts +0 -4
  69. package/dist/namespaces/atom/common/types.js +0 -2
  70. package/dist/namespaces/atom/generate/utils.d.ts +0 -4
  71. package/dist/namespaces/atom/generate/utils.js +0 -7
  72. package/dist/namespaces/atom/parse/utils.d.ts +0 -4
  73. package/dist/namespaces/atom/parse/utils.js +0 -7
  74. package/dist/namespaces/content/common/types.d.ts +0 -3
  75. package/dist/namespaces/content/common/types.js +0 -2
  76. package/dist/namespaces/content/generate/utils.d.ts +0 -3
  77. package/dist/namespaces/content/generate/utils.js +0 -10
  78. package/dist/namespaces/content/parse/utils.d.ts +0 -3
  79. package/dist/namespaces/content/parse/utils.js +0 -10
  80. package/dist/namespaces/dc/common/types.d.ts +0 -18
  81. package/dist/namespaces/dc/common/types.js +0 -2
  82. package/dist/namespaces/dc/generate/utils.d.ts +0 -3
  83. package/dist/namespaces/dc/generate/utils.js +0 -24
  84. package/dist/namespaces/dc/parse/utils.d.ts +0 -3
  85. package/dist/namespaces/dc/parse/utils.js +0 -24
  86. package/dist/namespaces/dcterms/common/types.d.ts +0 -58
  87. package/dist/namespaces/dcterms/common/types.js +0 -2
  88. package/dist/namespaces/dcterms/generate/utils.d.ts +0 -3
  89. package/dist/namespaces/dcterms/generate/utils.js +0 -64
  90. package/dist/namespaces/dcterms/parse/utils.d.ts +0 -3
  91. package/dist/namespaces/dcterms/parse/utils.js +0 -64
  92. package/dist/namespaces/georss/common/types.d.ts +0 -26
  93. package/dist/namespaces/georss/common/types.js +0 -2
  94. package/dist/namespaces/georss/generate/utils.d.ts +0 -11
  95. package/dist/namespaces/georss/generate/utils.js +0 -60
  96. package/dist/namespaces/georss/parse/utils.d.ts +0 -11
  97. package/dist/namespaces/georss/parse/utils.js +0 -68
  98. package/dist/namespaces/itunes/common/types.d.ts +0 -44
  99. package/dist/namespaces/itunes/common/types.js +0 -2
  100. package/dist/namespaces/itunes/generate/utils.d.ts +0 -7
  101. package/dist/namespaces/itunes/generate/utils.js +0 -70
  102. package/dist/namespaces/itunes/parse/utils.d.ts +0 -9
  103. package/dist/namespaces/itunes/parse/utils.js +0 -99
  104. package/dist/namespaces/media/common/types.d.ts +0 -172
  105. package/dist/namespaces/media/common/types.js +0 -2
  106. package/dist/namespaces/media/generate/utils.d.ts +0 -33
  107. package/dist/namespaces/media/generate/utils.js +0 -350
  108. package/dist/namespaces/media/parse/utils.d.ts +0 -35
  109. package/dist/namespaces/media/parse/utils.js +0 -344
  110. package/dist/namespaces/podcast/common/types.d.ts +0 -182
  111. package/dist/namespaces/podcast/common/types.js +0 -2
  112. package/dist/namespaces/podcast/generate/utils.d.ts +0 -32
  113. package/dist/namespaces/podcast/generate/utils.js +0 -362
  114. package/dist/namespaces/podcast/parse/utils.d.ts +0 -31
  115. package/dist/namespaces/podcast/parse/utils.js +0 -330
  116. package/dist/namespaces/slash/common/types.d.ts +0 -7
  117. package/dist/namespaces/slash/common/types.js +0 -2
  118. package/dist/namespaces/slash/generate/utils.d.ts +0 -3
  119. package/dist/namespaces/slash/generate/utils.js +0 -13
  120. package/dist/namespaces/slash/parse/utils.d.ts +0 -4
  121. package/dist/namespaces/slash/parse/utils.js +0 -16
  122. package/dist/namespaces/source/common/types.d.ts +0 -32
  123. package/dist/namespaces/source/common/types.js +0 -2
  124. package/dist/namespaces/source/generate/utils.d.ts +0 -8
  125. package/dist/namespaces/source/generate/utils.js +0 -68
  126. package/dist/namespaces/source/parse/utils.d.ts +0 -8
  127. package/dist/namespaces/source/parse/utils.js +0 -69
  128. package/dist/namespaces/sy/common/types.d.ts +0 -6
  129. package/dist/namespaces/sy/common/types.js +0 -2
  130. package/dist/namespaces/sy/generate/utils.d.ts +0 -3
  131. package/dist/namespaces/sy/generate/utils.js +0 -12
  132. package/dist/namespaces/sy/parse/utils.d.ts +0 -3
  133. package/dist/namespaces/sy/parse/utils.js +0 -12
  134. package/dist/namespaces/thr/common/types.d.ts +0 -15
  135. package/dist/namespaces/thr/common/types.js +0 -2
  136. package/dist/namespaces/thr/generate/utils.d.ts +0 -5
  137. package/dist/namespaces/thr/generate/utils.js +0 -33
  138. package/dist/namespaces/thr/parse/utils.d.ts +0 -5
  139. package/dist/namespaces/thr/parse/utils.js +0 -33
  140. package/dist/namespaces/wfw/common/types.d.ts +0 -4
  141. package/dist/namespaces/wfw/common/types.js +0 -2
  142. package/dist/namespaces/wfw/generate/utils.d.ts +0 -3
  143. package/dist/namespaces/wfw/generate/utils.js +0 -11
  144. package/dist/namespaces/wfw/parse/utils.d.ts +0 -3
  145. package/dist/namespaces/wfw/parse/utils.js +0 -11
  146. package/dist/namespaces/yt/common/types.d.ts +0 -8
  147. package/dist/namespaces/yt/common/types.js +0 -2
  148. package/dist/namespaces/yt/generate/utils.d.ts +0 -4
  149. package/dist/namespaces/yt/generate/utils.js +0 -21
  150. package/dist/namespaces/yt/parse/utils.d.ts +0 -4
  151. package/dist/namespaces/yt/parse/utils.js +0 -21
  152. package/dist/opml/common/types.d.ts +0 -39
  153. package/dist/opml/common/types.js +0 -2
  154. package/dist/opml/generate/config.d.ts +0 -2
  155. package/dist/opml/generate/config.js +0 -5
  156. package/dist/opml/generate/index.d.ts +0 -3
  157. package/dist/opml/generate/index.js +0 -10
  158. package/dist/opml/generate/utils.d.ts +0 -6
  159. package/dist/opml/generate/utils.js +0 -66
  160. package/dist/opml/parse/config.d.ts +0 -3
  161. package/dist/opml/parse/config.js +0 -22
  162. package/dist/opml/parse/index.d.ts +0 -3
  163. package/dist/opml/parse/index.js +0 -10
  164. package/dist/opml/parse/utils.d.ts +0 -6
  165. package/dist/opml/parse/utils.js +0 -63
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  [![npm version](https://img.shields.io/npm/v/feedsmith.svg)](https://www.npmjs.com/package/feedsmith)
6
6
  [![license](https://img.shields.io/npm/l/feedsmith.svg)](https://github.com/macieklamberski/feedsmith/blob/main/LICENSE)
7
7
 
8
- Fast, all‑in‑one JavaScript parser and generator for RSS, Atom, JSON Feed, and RDF feeds, with support for popular namespaces and OPML files.
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, JSON Feed, and RDF
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
- ### Use Format-Specific Parsers
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