feedsmith 3.0.0-rc.3 → 3.0.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 +33 -24
- package/dist/common/config.cjs +1 -1
- package/dist/common/config.js +1 -1
- package/dist/common/errors.d.cts +5 -6
- package/dist/common/errors.d.ts +5 -6
- package/dist/common/parse.d.cts +3 -4
- package/dist/common/parse.d.ts +3 -4
- package/dist/common/types.d.cts +11 -14
- package/dist/common/types.d.ts +11 -14
- package/dist/common/utils.cjs +2 -19
- package/dist/common/utils.js +2 -18
- package/dist/feeds/atom/common/types.d.cts +2 -3
- package/dist/feeds/atom/common/types.d.ts +2 -3
- package/dist/feeds/atom/detect/index.d.cts +2 -3
- package/dist/feeds/atom/detect/index.d.ts +2 -3
- package/dist/feeds/atom/generate/index.d.cts +2 -3
- package/dist/feeds/atom/generate/index.d.ts +2 -3
- package/dist/feeds/atom/generate/utils.cjs +41 -29
- package/dist/feeds/atom/generate/utils.js +40 -28
- package/dist/feeds/atom/parse/index.d.cts +2 -3
- package/dist/feeds/atom/parse/index.d.ts +2 -3
- package/dist/feeds/atom/parse/utils.cjs +34 -22
- package/dist/feeds/atom/parse/utils.js +35 -23
- package/dist/feeds/json/common/types.d.cts +2 -3
- package/dist/feeds/json/common/types.d.ts +2 -3
- package/dist/feeds/json/detect/index.d.cts +2 -3
- package/dist/feeds/json/detect/index.d.ts +2 -3
- package/dist/feeds/json/generate/index.d.cts +2 -3
- package/dist/feeds/json/generate/index.d.ts +2 -3
- package/dist/feeds/json/generate/utils.cjs +7 -4
- package/dist/feeds/json/generate/utils.js +8 -5
- package/dist/feeds/json/parse/index.d.cts +2 -3
- package/dist/feeds/json/parse/index.d.ts +2 -3
- package/dist/feeds/json/parse/utils.cjs +20 -11
- package/dist/feeds/json/parse/utils.js +21 -12
- package/dist/feeds/rdf/common/types.d.cts +5 -3
- package/dist/feeds/rdf/common/types.d.ts +5 -3
- package/dist/feeds/rdf/detect/index.d.cts +2 -3
- package/dist/feeds/rdf/detect/index.d.ts +2 -3
- package/dist/feeds/rdf/parse/index.d.cts +2 -3
- package/dist/feeds/rdf/parse/index.d.ts +2 -3
- package/dist/feeds/rdf/parse/utils.cjs +55 -41
- package/dist/feeds/rdf/parse/utils.js +40 -26
- package/dist/feeds/rss/common/types.d.cts +2 -3
- package/dist/feeds/rss/common/types.d.ts +2 -3
- package/dist/feeds/rss/detect/index.d.cts +2 -3
- package/dist/feeds/rss/detect/index.d.ts +2 -3
- package/dist/feeds/rss/generate/index.d.cts +2 -3
- package/dist/feeds/rss/generate/index.d.ts +2 -3
- package/dist/feeds/rss/generate/utils.cjs +32 -20
- package/dist/feeds/rss/generate/utils.js +33 -21
- package/dist/feeds/rss/parse/index.d.cts +2 -3
- package/dist/feeds/rss/parse/index.d.ts +2 -3
- package/dist/feeds/rss/parse/utils.cjs +38 -24
- package/dist/feeds/rss/parse/utils.js +38 -24
- package/dist/index.d.cts +5 -5
- package/dist/index.d.ts +5 -5
- package/dist/namespaces/acast/common/types.d.cts +2 -3
- package/dist/namespaces/acast/common/types.d.ts +2 -3
- package/dist/namespaces/acast/generate/utils.cjs +13 -8
- package/dist/namespaces/acast/generate/utils.js +14 -9
- package/dist/namespaces/acast/parse/utils.cjs +13 -8
- package/dist/namespaces/acast/parse/utils.js +14 -9
- package/dist/namespaces/admin/common/types.d.cts +2 -3
- package/dist/namespaces/admin/common/types.d.ts +2 -3
- package/dist/namespaces/admin/generate/utils.cjs +4 -2
- package/dist/namespaces/admin/generate/utils.js +5 -3
- package/dist/namespaces/admin/parse/utils.cjs +4 -2
- package/dist/namespaces/admin/parse/utils.js +5 -3
- package/dist/namespaces/app/common/types.d.cts +2 -3
- package/dist/namespaces/app/common/types.d.ts +2 -3
- package/dist/namespaces/app/generate/utils.cjs +6 -3
- package/dist/namespaces/app/generate/utils.js +7 -4
- package/dist/namespaces/app/parse/utils.cjs +6 -3
- package/dist/namespaces/app/parse/utils.js +7 -4
- package/dist/namespaces/arxiv/common/types.d.cts +2 -3
- package/dist/namespaces/arxiv/common/types.d.ts +2 -3
- package/dist/namespaces/arxiv/generate/utils.cjs +9 -5
- package/dist/namespaces/arxiv/generate/utils.js +10 -6
- package/dist/namespaces/arxiv/parse/utils.cjs +9 -5
- package/dist/namespaces/arxiv/parse/utils.js +10 -6
- package/dist/namespaces/atom/common/types.d.cts +3 -4
- package/dist/namespaces/atom/common/types.d.ts +3 -4
- package/dist/namespaces/blogchannel/common/types.d.cts +2 -3
- package/dist/namespaces/blogchannel/common/types.d.ts +2 -3
- package/dist/namespaces/blogchannel/generate/utils.cjs +4 -2
- package/dist/namespaces/blogchannel/generate/utils.js +5 -3
- package/dist/namespaces/blogchannel/parse/utils.cjs +4 -2
- package/dist/namespaces/blogchannel/parse/utils.js +5 -3
- package/dist/namespaces/cc/common/types.d.cts +2 -3
- package/dist/namespaces/cc/common/types.d.ts +2 -3
- package/dist/namespaces/cc/generate/utils.cjs +4 -2
- package/dist/namespaces/cc/generate/utils.js +5 -3
- package/dist/namespaces/cc/parse/utils.cjs +4 -2
- package/dist/namespaces/cc/parse/utils.js +5 -3
- package/dist/namespaces/content/common/types.d.cts +2 -3
- package/dist/namespaces/content/common/types.d.ts +2 -3
- package/dist/namespaces/content/generate/utils.cjs +3 -1
- package/dist/namespaces/content/generate/utils.js +4 -2
- package/dist/namespaces/content/parse/utils.cjs +3 -1
- package/dist/namespaces/content/parse/utils.js +4 -2
- package/dist/namespaces/creativecommons/common/types.d.cts +2 -3
- package/dist/namespaces/creativecommons/common/types.d.ts +2 -3
- package/dist/namespaces/creativecommons/generate/utils.cjs +3 -1
- package/dist/namespaces/creativecommons/generate/utils.js +4 -2
- package/dist/namespaces/creativecommons/parse/utils.cjs +3 -1
- package/dist/namespaces/creativecommons/parse/utils.js +4 -2
- package/dist/namespaces/dc/common/types.d.cts +2 -3
- package/dist/namespaces/dc/common/types.d.ts +2 -3
- package/dist/namespaces/dc/generate/utils.cjs +4 -2
- package/dist/namespaces/dc/generate/utils.js +5 -3
- package/dist/namespaces/dc/parse/utils.cjs +4 -2
- package/dist/namespaces/dc/parse/utils.js +5 -3
- package/dist/namespaces/dcterms/common/types.d.cts +2 -3
- package/dist/namespaces/dcterms/common/types.d.ts +2 -3
- package/dist/namespaces/dcterms/generate/utils.cjs +4 -2
- package/dist/namespaces/dcterms/generate/utils.js +5 -3
- package/dist/namespaces/dcterms/parse/utils.cjs +4 -2
- package/dist/namespaces/dcterms/parse/utils.js +5 -3
- package/dist/namespaces/feedpress/common/types.d.cts +2 -3
- package/dist/namespaces/feedpress/common/types.d.ts +2 -3
- package/dist/namespaces/feedpress/generate/utils.cjs +4 -2
- package/dist/namespaces/feedpress/generate/utils.js +5 -3
- package/dist/namespaces/feedpress/parse/utils.cjs +4 -2
- package/dist/namespaces/feedpress/parse/utils.js +5 -3
- package/dist/namespaces/geo/common/types.d.cts +2 -3
- package/dist/namespaces/geo/common/types.d.ts +2 -3
- package/dist/namespaces/geo/generate/utils.cjs +4 -2
- package/dist/namespaces/geo/generate/utils.js +5 -3
- package/dist/namespaces/geo/parse/utils.cjs +4 -2
- package/dist/namespaces/geo/parse/utils.js +5 -3
- package/dist/namespaces/georss/common/types.d.cts +2 -3
- package/dist/namespaces/georss/common/types.d.ts +2 -3
- package/dist/namespaces/georss/generate/utils.cjs +4 -2
- package/dist/namespaces/georss/generate/utils.js +5 -3
- package/dist/namespaces/georss/parse/utils.cjs +4 -2
- package/dist/namespaces/georss/parse/utils.js +5 -3
- package/dist/namespaces/googleplay/common/types.d.cts +2 -3
- package/dist/namespaces/googleplay/common/types.d.ts +2 -3
- package/dist/namespaces/googleplay/generate/utils.cjs +7 -4
- package/dist/namespaces/googleplay/generate/utils.js +6 -3
- package/dist/namespaces/googleplay/parse/utils.cjs +15 -6
- package/dist/namespaces/googleplay/parse/utils.js +16 -7
- package/dist/namespaces/itunes/common/types.d.cts +2 -3
- package/dist/namespaces/itunes/common/types.d.ts +2 -3
- package/dist/namespaces/itunes/generate/utils.cjs +13 -8
- package/dist/namespaces/itunes/generate/utils.js +14 -9
- package/dist/namespaces/itunes/parse/utils.cjs +13 -8
- package/dist/namespaces/itunes/parse/utils.js +14 -9
- package/dist/namespaces/media/common/types.d.cts +2 -3
- package/dist/namespaces/media/common/types.d.ts +2 -3
- package/dist/namespaces/media/generate/utils.cjs +89 -57
- package/dist/namespaces/media/generate/utils.js +90 -58
- package/dist/namespaces/media/parse/utils.cjs +82 -52
- package/dist/namespaces/media/parse/utils.js +83 -53
- package/dist/namespaces/opensearch/common/types.d.cts +2 -3
- package/dist/namespaces/opensearch/common/types.d.ts +2 -3
- package/dist/namespaces/opensearch/generate/utils.cjs +7 -4
- package/dist/namespaces/opensearch/generate/utils.js +8 -5
- package/dist/namespaces/opensearch/parse/utils.cjs +7 -4
- package/dist/namespaces/opensearch/parse/utils.js +8 -5
- package/dist/namespaces/pingback/common/types.d.cts +2 -3
- package/dist/namespaces/pingback/common/types.d.ts +2 -3
- package/dist/namespaces/pingback/generate/utils.cjs +6 -3
- package/dist/namespaces/pingback/generate/utils.js +7 -4
- package/dist/namespaces/pingback/parse/utils.cjs +6 -3
- package/dist/namespaces/pingback/parse/utils.js +7 -4
- package/dist/namespaces/podcast/common/types.d.cts +2 -3
- package/dist/namespaces/podcast/common/types.d.ts +2 -3
- package/dist/namespaces/podcast/generate/utils.cjs +91 -59
- package/dist/namespaces/podcast/generate/utils.js +92 -60
- package/dist/namespaces/podcast/parse/utils.cjs +92 -60
- package/dist/namespaces/podcast/parse/utils.js +92 -60
- package/dist/namespaces/prism/common/types.d.cts +2 -3
- package/dist/namespaces/prism/common/types.d.ts +2 -3
- package/dist/namespaces/prism/generate/utils.cjs +7 -4
- package/dist/namespaces/prism/generate/utils.js +8 -5
- package/dist/namespaces/prism/parse/utils.cjs +7 -4
- package/dist/namespaces/prism/parse/utils.js +8 -5
- package/dist/namespaces/psc/common/types.d.cts +2 -3
- package/dist/namespaces/psc/common/types.d.ts +2 -3
- package/dist/namespaces/psc/generate/utils.cjs +7 -4
- package/dist/namespaces/psc/generate/utils.js +7 -4
- package/dist/namespaces/psc/parse/utils.cjs +6 -3
- package/dist/namespaces/psc/parse/utils.js +7 -4
- package/dist/namespaces/rawvoice/common/types.d.cts +2 -3
- package/dist/namespaces/rawvoice/common/types.d.ts +2 -3
- package/dist/namespaces/rawvoice/generate/utils.cjs +25 -16
- package/dist/namespaces/rawvoice/generate/utils.js +25 -16
- package/dist/namespaces/rawvoice/parse/utils.cjs +25 -16
- package/dist/namespaces/rawvoice/parse/utils.js +25 -16
- package/dist/namespaces/rdf/common/types.d.cts +2 -3
- package/dist/namespaces/rdf/common/types.d.ts +2 -3
- package/dist/namespaces/rdf/parse/utils.cjs +3 -1
- package/dist/namespaces/rdf/parse/utils.js +4 -2
- package/dist/namespaces/slash/common/types.d.cts +2 -3
- package/dist/namespaces/slash/common/types.d.ts +2 -3
- package/dist/namespaces/slash/generate/utils.cjs +4 -2
- package/dist/namespaces/slash/generate/utils.js +5 -3
- package/dist/namespaces/slash/parse/utils.cjs +4 -2
- package/dist/namespaces/slash/parse/utils.js +5 -3
- package/dist/namespaces/source/common/types.d.cts +2 -3
- package/dist/namespaces/source/common/types.d.ts +2 -3
- package/dist/namespaces/source/generate/utils.cjs +19 -12
- package/dist/namespaces/source/generate/utils.js +20 -13
- package/dist/namespaces/source/parse/utils.cjs +21 -13
- package/dist/namespaces/source/parse/utils.js +22 -14
- package/dist/namespaces/spotify/common/types.d.cts +2 -3
- package/dist/namespaces/spotify/common/types.d.ts +2 -3
- package/dist/namespaces/spotify/generate/utils.cjs +17 -9
- package/dist/namespaces/spotify/generate/utils.js +18 -10
- package/dist/namespaces/spotify/parse/utils.cjs +13 -7
- package/dist/namespaces/spotify/parse/utils.js +14 -8
- package/dist/namespaces/sy/common/types.d.cts +2 -3
- package/dist/namespaces/sy/common/types.d.ts +2 -3
- package/dist/namespaces/sy/generate/utils.cjs +4 -2
- package/dist/namespaces/sy/generate/utils.js +5 -3
- package/dist/namespaces/sy/parse/utils.cjs +4 -2
- package/dist/namespaces/sy/parse/utils.js +5 -3
- package/dist/namespaces/thr/common/types.d.cts +2 -3
- package/dist/namespaces/thr/common/types.d.ts +2 -3
- package/dist/namespaces/thr/generate/utils.cjs +10 -6
- package/dist/namespaces/thr/generate/utils.js +11 -7
- package/dist/namespaces/thr/parse/utils.cjs +10 -6
- package/dist/namespaces/thr/parse/utils.js +11 -7
- package/dist/namespaces/trackback/common/types.d.cts +2 -3
- package/dist/namespaces/trackback/common/types.d.ts +2 -3
- package/dist/namespaces/trackback/generate/utils.cjs +4 -2
- package/dist/namespaces/trackback/generate/utils.js +5 -3
- package/dist/namespaces/trackback/parse/utils.cjs +4 -2
- package/dist/namespaces/trackback/parse/utils.js +5 -3
- package/dist/namespaces/wfw/common/types.d.cts +2 -3
- package/dist/namespaces/wfw/common/types.d.ts +2 -3
- package/dist/namespaces/wfw/generate/utils.cjs +4 -2
- package/dist/namespaces/wfw/generate/utils.js +5 -3
- package/dist/namespaces/wfw/parse/utils.cjs +4 -2
- package/dist/namespaces/wfw/parse/utils.js +5 -3
- package/dist/namespaces/xml/common/types.d.cts +2 -3
- package/dist/namespaces/xml/common/types.d.ts +2 -3
- package/dist/namespaces/xml/generate/utils.cjs +4 -2
- package/dist/namespaces/xml/generate/utils.js +5 -3
- package/dist/namespaces/xml/parse/utils.cjs +4 -2
- package/dist/namespaces/xml/parse/utils.js +5 -3
- package/dist/namespaces/yt/common/types.d.cts +2 -3
- package/dist/namespaces/yt/common/types.d.ts +2 -3
- package/dist/namespaces/yt/generate/utils.cjs +7 -4
- package/dist/namespaces/yt/generate/utils.js +8 -5
- package/dist/namespaces/yt/parse/utils.cjs +7 -4
- package/dist/namespaces/yt/parse/utils.js +8 -5
- package/dist/node_modules/trousse/dist/objects.cjs +21 -0
- package/dist/node_modules/trousse/dist/objects.js +21 -0
- package/dist/node_modules/trousse/dist/types.d.cts +4 -0
- package/dist/node_modules/trousse/dist/types.d.ts +4 -0
- package/dist/opml/common/types.d.cts +4 -5
- package/dist/opml/common/types.d.ts +4 -5
- package/dist/opml/generate/index.d.cts +2 -3
- package/dist/opml/generate/index.d.ts +2 -3
- package/dist/opml/generate/utils.cjs +8 -5
- package/dist/opml/generate/utils.js +7 -4
- package/dist/opml/parse/index.d.cts +2 -3
- package/dist/opml/parse/index.d.ts +2 -3
- package/dist/opml/parse/utils.cjs +10 -6
- package/dist/opml/parse/utils.js +10 -6
- package/package.json +8 -7
package/README.md
CHANGED
|
@@ -6,7 +6,10 @@
|
|
|
6
6
|
|
|
7
7
|
Fast, all‑in‑one JavaScript feed parser and generator for RSS, Atom, RDF, and JSON Feed, with support for popular namespaces and OPML files.
|
|
8
8
|
|
|
9
|
-
Feedsmith
|
|
9
|
+
Feedsmith's universal and format-specific parsers turn each feed into an object that mirrors its original structure and maps legacy elements to their modern equivalents, so you read an old feed the same way as a new one.
|
|
10
|
+
|
|
11
|
+
> [!IMPORTANT]
|
|
12
|
+
> **Feedsmith 3.0 is out! 🎉** It comes with a range of improvements and some breaking changes. Check out the [migration guide](https://feedsmith.dev/migration/v2-to-v3) to see what's new and how to upgrade from 2.x.
|
|
10
13
|
|
|
11
14
|
**[Read full docs ↗](https://feedsmith.dev)**
|
|
12
15
|
·
|
|
@@ -22,27 +25,30 @@ Feedsmith offers universal and format‑specific parsers that maintain the origi
|
|
|
22
25
|
|
|
23
26
|
### Core
|
|
24
27
|
|
|
25
|
-
* **Comprehensive support
|
|
26
|
-
* **Preserves structure
|
|
27
|
-
* **Smart namespace handling
|
|
28
|
-
* **Parsing & generating
|
|
28
|
+
* **Comprehensive support**: Supports all major feed formats and namespaces.
|
|
29
|
+
* **Preserves structure**: Parsed feed object maintains the original feed structure making it easy to access the data.
|
|
30
|
+
* **Smart namespace handling**: Normalizes custom namespace prefixes to standard ones (e.g., `<custom:creator>` becomes `dc.creator`).
|
|
31
|
+
* **Parsing & generating**: Use one package for both parsing and generating feeds.
|
|
29
32
|
|
|
30
33
|
### Leniency
|
|
31
|
-
|
|
32
|
-
* **
|
|
33
|
-
* **
|
|
34
|
-
* **
|
|
34
|
+
|
|
35
|
+
* **Normalizes legacy elements**: Upgrades feed elements to their modern equivalents so that you never need to worry about reading feeds in older formats.
|
|
36
|
+
* **CaSe INSENsiTive**: Handles fields and attributes in any case (lowercase, uppercase, mixed).
|
|
37
|
+
* **Namespace URI tolerance**: Accepts non-official namespace URIs (HTTPS variants, case variations, trailing slashes, whitespace).
|
|
38
|
+
* **Forgiving**: Gracefully handles malformed or incomplete feeds and extracts valid data. This makes it suitable for use with real-world feeds that may not strictly follow specifications.
|
|
35
39
|
|
|
36
40
|
### Performance
|
|
37
|
-
|
|
38
|
-
* **
|
|
39
|
-
* **
|
|
40
|
-
* **
|
|
41
|
+
|
|
42
|
+
* **Ultrafast parsing**: One of the fastest JavaScript feed parsers ([see benchmarks](https://feedsmith.dev/benchmarks)).
|
|
43
|
+
* **Type-safe API**: Built with TypeScript from the ground up, it provides complete type definitions for every feed format and namespace.
|
|
44
|
+
* **Tree-shakable**: Only include the parts of the library you need, reducing bundle size.
|
|
45
|
+
* **Well-tested**: Comprehensive test suite with over 4000 tests and 99% code coverage.
|
|
41
46
|
|
|
42
47
|
### Compatibility
|
|
43
|
-
|
|
48
|
+
|
|
49
|
+
* Works in Node.js and modern browsers.
|
|
44
50
|
* Supports both CommonJS and ES modules.
|
|
45
|
-
* Works with plain JavaScript, you don't need
|
|
51
|
+
* Works with plain JavaScript, so you don't need TypeScript.
|
|
46
52
|
|
|
47
53
|
## Supported Formats
|
|
48
54
|
|
|
@@ -61,13 +67,13 @@ Feedsmith aims to fully support all major feed formats and namespaces in complet
|
|
|
61
67
|
| [RSS](https://feedsmith.dev/reference/feeds/rss) | 0.9x, 2.0 | ✅ | ✅ |
|
|
62
68
|
| [Atom](https://feedsmith.dev/reference/feeds/atom) | 0.3, 1.0 | ✅ | ✅ |
|
|
63
69
|
| [RDF](https://feedsmith.dev/reference/feeds/rdf) | 0.9, 1.0 | ✅ | 📋 |
|
|
64
|
-
| [JSON Feed](https://feedsmith.dev/reference/feeds/json) | 1.0, 1.1 | ✅ | ✅ |
|
|
70
|
+
| [JSON Feed](https://feedsmith.dev/reference/feeds/json-feed) | 1.0, 1.1 | ✅ | ✅ |
|
|
65
71
|
|
|
66
72
|
### Other
|
|
67
73
|
|
|
68
74
|
| Format | Versions | Parse | Generate |
|
|
69
75
|
|--------|----------|-------|----------|
|
|
70
|
-
| [OPML](https://feedsmith.dev/reference/
|
|
76
|
+
| [OPML](https://feedsmith.dev/reference/opml) | 1.0, 2.0 | ✅ | ✅ |
|
|
71
77
|
|
|
72
78
|
### Feed Namespaces
|
|
73
79
|
|
|
@@ -91,7 +97,7 @@ Feedsmith aims to fully support all major feed formats and namespaces in complet
|
|
|
91
97
|
| [arXiv](https://feedsmith.dev/reference/namespaces/arxiv) | `<arxiv:*>` | Atom | ✅ | ✅ |
|
|
92
98
|
| [OpenSearch](https://feedsmith.dev/reference/namespaces/opensearch) | `<opensearch:*>` | RSS, Atom | ✅ | ✅ |
|
|
93
99
|
| [PRISM](https://feedsmith.dev/reference/namespaces/prism) | `<prism:*>` | RSS | ✅ | ✅ |
|
|
94
|
-
| [ccREL](https://feedsmith.dev/reference/namespaces/cc) | `<cc:*>` | RSS, Atom | ✅ | ✅ |
|
|
100
|
+
| [ccREL](https://feedsmith.dev/reference/namespaces/cc) | `<cc:*>` | RSS, Atom, RDF | ✅ | ✅ |
|
|
95
101
|
| [Creative Commons](https://feedsmith.dev/reference/namespaces/creativecommons) | `<creativeCommons:*>` | RSS, Atom | ✅ | ✅ |
|
|
96
102
|
| [Atom Threading](https://feedsmith.dev/reference/namespaces/thr) | `<thr:*>` | RSS, Atom | ✅ | ✅ |
|
|
97
103
|
| [Atom Publishing Protocol](https://feedsmith.dev/reference/namespaces/app) | `<app:*>` | Atom | ✅ | ✅ |
|
|
@@ -119,7 +125,7 @@ For a full overview of all the features, visit the [documentation website](https
|
|
|
119
125
|
npm install feedsmith
|
|
120
126
|
```
|
|
121
127
|
|
|
122
|
-
> **Migrating from
|
|
128
|
+
> **Migrating from v2.x?** Check out the [migration guide](https://feedsmith.dev/migration/v2-to-v3).
|
|
123
129
|
|
|
124
130
|
### Parse Any Feed
|
|
125
131
|
|
|
@@ -225,13 +231,16 @@ try {
|
|
|
225
231
|
Feedsmith provides comprehensive TypeScript types for all feed formats:
|
|
226
232
|
|
|
227
233
|
```typescript
|
|
228
|
-
import type {
|
|
234
|
+
import type { AnyFeed, AtomFeed, JsonFeed, Opml, RssFeed } from 'feedsmith'
|
|
229
235
|
|
|
230
236
|
// Access all types for a format
|
|
231
|
-
type Feed =
|
|
232
|
-
type Item =
|
|
233
|
-
type Category =
|
|
234
|
-
type Enclosure =
|
|
237
|
+
type Feed = RssFeed.Feed<string>
|
|
238
|
+
type Item = RssFeed.Item<string>
|
|
239
|
+
type Category = RssFeed.Category
|
|
240
|
+
type Enclosure = RssFeed.Enclosure
|
|
241
|
+
|
|
242
|
+
// Return type of parseFeed
|
|
243
|
+
type Result = AnyFeed
|
|
235
244
|
```
|
|
236
245
|
|
|
237
246
|
## Why Feedsmith?
|
package/dist/common/config.cjs
CHANGED
|
@@ -106,7 +106,7 @@ const namespacePrefixes = Object.entries(namespaceUris).reduce((prefixes, [prefi
|
|
|
106
106
|
prefixes[normalizedUri] = prefix.toLowerCase();
|
|
107
107
|
}
|
|
108
108
|
return prefixes;
|
|
109
|
-
},
|
|
109
|
+
}, Object.create(null));
|
|
110
110
|
const namespaceStopNodes = [
|
|
111
111
|
...require_config.stopNodes,
|
|
112
112
|
...require_config$1.stopNodes,
|
package/dist/common/config.js
CHANGED
|
@@ -106,7 +106,7 @@ const namespacePrefixes = Object.entries(namespaceUris).reduce((prefixes, [prefi
|
|
|
106
106
|
prefixes[normalizedUri] = prefix.toLowerCase();
|
|
107
107
|
}
|
|
108
108
|
return prefixes;
|
|
109
|
-
},
|
|
109
|
+
}, Object.create(null));
|
|
110
110
|
const namespaceStopNodes = [
|
|
111
111
|
...stopNodes,
|
|
112
112
|
...stopNodes$1,
|
package/dist/common/errors.d.cts
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
//#region src/common/errors.d.ts
|
|
2
|
-
declare class DetectError extends Error {
|
|
2
|
+
export declare class DetectError extends Error {
|
|
3
3
|
constructor(message: string);
|
|
4
4
|
}
|
|
5
|
-
declare class GenerateError extends Error {
|
|
5
|
+
export declare class GenerateError extends Error {
|
|
6
6
|
constructor(message: string);
|
|
7
7
|
}
|
|
8
|
-
declare class MalformedError extends Error {
|
|
8
|
+
export declare class MalformedError extends Error {
|
|
9
9
|
constructor(message: string, options?: ErrorOptions);
|
|
10
10
|
}
|
|
11
|
-
declare class ParseError extends Error {
|
|
11
|
+
export declare class ParseError extends Error {
|
|
12
12
|
constructor(message: string);
|
|
13
13
|
}
|
|
14
|
-
//#endregion
|
|
15
|
-
export { DetectError, GenerateError, MalformedError, ParseError };
|
|
14
|
+
//#endregion
|
package/dist/common/errors.d.ts
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
//#region src/common/errors.d.ts
|
|
2
|
-
declare class DetectError extends Error {
|
|
2
|
+
export declare class DetectError extends Error {
|
|
3
3
|
constructor(message: string);
|
|
4
4
|
}
|
|
5
|
-
declare class GenerateError extends Error {
|
|
5
|
+
export declare class GenerateError extends Error {
|
|
6
6
|
constructor(message: string);
|
|
7
7
|
}
|
|
8
|
-
declare class MalformedError extends Error {
|
|
8
|
+
export declare class MalformedError extends Error {
|
|
9
9
|
constructor(message: string, options?: ErrorOptions);
|
|
10
10
|
}
|
|
11
|
-
declare class ParseError extends Error {
|
|
11
|
+
export declare class ParseError extends Error {
|
|
12
12
|
constructor(message: string);
|
|
13
13
|
}
|
|
14
|
-
//#endregion
|
|
15
|
-
export { DetectError, GenerateError, MalformedError, ParseError };
|
|
14
|
+
//#endregion
|
package/dist/common/parse.d.cts
CHANGED
|
@@ -4,7 +4,7 @@ import { JsonFeed } from "../feeds/json/common/types.cjs";
|
|
|
4
4
|
import { RdfFeed } from "../feeds/rdf/common/types.cjs";
|
|
5
5
|
import { RssFeed } from "../feeds/rss/common/types.cjs";
|
|
6
6
|
//#region src/common/parse.d.ts
|
|
7
|
-
type AnyFeed<TDate = string> = {
|
|
7
|
+
export type AnyFeed<TDate = string> = {
|
|
8
8
|
format: 'rss';
|
|
9
9
|
feed: RssFeed.Feed<TDate>;
|
|
10
10
|
} | {
|
|
@@ -17,6 +17,5 @@ type AnyFeed<TDate = string> = {
|
|
|
17
17
|
format: 'json';
|
|
18
18
|
feed: JsonFeed.Feed<TDate>;
|
|
19
19
|
};
|
|
20
|
-
declare const parse: <TDate = string>(value: unknown, options?: ParseMainOptions<TDate>) => AnyFeed<TDate>;
|
|
21
|
-
//#endregion
|
|
22
|
-
export { AnyFeed, parse };
|
|
20
|
+
export declare const parse: <TDate = string>(value: unknown, options?: ParseMainOptions<TDate>) => AnyFeed<TDate>;
|
|
21
|
+
//#endregion
|
package/dist/common/parse.d.ts
CHANGED
|
@@ -4,7 +4,7 @@ import { JsonFeed } from "../feeds/json/common/types.js";
|
|
|
4
4
|
import { RdfFeed } from "../feeds/rdf/common/types.js";
|
|
5
5
|
import { RssFeed } from "../feeds/rss/common/types.js";
|
|
6
6
|
//#region src/common/parse.d.ts
|
|
7
|
-
type AnyFeed<TDate = string> = {
|
|
7
|
+
export type AnyFeed<TDate = string> = {
|
|
8
8
|
format: 'rss';
|
|
9
9
|
feed: RssFeed.Feed<TDate>;
|
|
10
10
|
} | {
|
|
@@ -17,6 +17,5 @@ type AnyFeed<TDate = string> = {
|
|
|
17
17
|
format: 'json';
|
|
18
18
|
feed: JsonFeed.Feed<TDate>;
|
|
19
19
|
};
|
|
20
|
-
declare const parse: <TDate = string>(value: unknown, options?: ParseMainOptions<TDate>) => AnyFeed<TDate>;
|
|
21
|
-
//#endregion
|
|
22
|
-
export { AnyFeed, parse };
|
|
20
|
+
export declare const parse: <TDate = string>(value: unknown, options?: ParseMainOptions<TDate>) => AnyFeed<TDate>;
|
|
21
|
+
//#endregion
|
package/dist/common/types.d.cts
CHANGED
|
@@ -8,19 +8,17 @@ type HasMarker<T> = [Extract<T, {
|
|
|
8
8
|
}>] extends [never] ? false : true;
|
|
9
9
|
type Optional<T> = { [K in keyof T]-?: object extends Pick<T, K> ? K : never; }[keyof T];
|
|
10
10
|
type Marked<T> = { [K in keyof T]-?: HasMarker<T[K]> extends true ? K : never; }[keyof T];
|
|
11
|
-
type Strict<T, S extends boolean> = Simplify<S extends true ? { [K in Exclude<keyof T, Optional<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T>]?: Unwrap<T[K]>; } : { [K in Exclude<keyof T, Optional<T> | Marked<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T> | Marked<T>]?: Unwrap<T[K]>; }>;
|
|
12
|
-
type
|
|
13
|
-
type DeepOmit<T, K extends string> = T extends Array<infer U> ? Array<DeepOmit<U, K>> : IsPlainObject<T> extends true ? Pick<{ [P in keyof T]: DeepOmit<T[P], K>; }, Exclude<keyof T, K>> : T;
|
|
14
|
-
type Requirable<T> = T | {
|
|
11
|
+
export type Strict<T, S extends boolean> = Simplify<S extends true ? { [K in Exclude<keyof T, Optional<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T>]?: Unwrap<T[K]>; } : { [K in Exclude<keyof T, Optional<T> | Marked<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T> | Marked<T>]?: Unwrap<T[K]>; }>;
|
|
12
|
+
export type Requirable<T> = T | {
|
|
15
13
|
__requirable: T;
|
|
16
14
|
};
|
|
17
|
-
type DateLike = Date | string;
|
|
18
|
-
type ExtraFields<F extends ReadonlyArray<string>, V = unknown> = { [K in F[number]]?: V; };
|
|
19
|
-
type ParseMainOptions<TDate> = {
|
|
15
|
+
export type DateLike = Date | string;
|
|
16
|
+
export type ExtraFields<F extends ReadonlyArray<string>, V = unknown> = { [K in F[number]]?: V; };
|
|
17
|
+
export type ParseMainOptions<TDate> = {
|
|
20
18
|
maxItems?: number;
|
|
21
19
|
parseDateFn?: (raw: string) => TDate;
|
|
22
20
|
};
|
|
23
|
-
type XmlStylesheet = {
|
|
21
|
+
export type XmlStylesheet = {
|
|
24
22
|
type: string;
|
|
25
23
|
href: string;
|
|
26
24
|
title?: string;
|
|
@@ -28,14 +26,13 @@ type XmlStylesheet = {
|
|
|
28
26
|
charset?: string;
|
|
29
27
|
alternate?: boolean;
|
|
30
28
|
};
|
|
31
|
-
type GenerateMainXmlOptions<O, S extends boolean> = O & {
|
|
29
|
+
export type GenerateMainXmlOptions<O, S extends boolean> = O & {
|
|
32
30
|
strict?: S;
|
|
33
31
|
stylesheets?: Array<XmlStylesheet>;
|
|
34
32
|
};
|
|
35
|
-
type GenerateMainXml<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainXmlOptions<O, S>) => string;
|
|
36
|
-
type GenerateMainJsonOptions<O, S extends boolean> = O & {
|
|
33
|
+
export type GenerateMainXml<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainXmlOptions<O, S>) => string;
|
|
34
|
+
export type GenerateMainJsonOptions<O, S extends boolean> = O & {
|
|
37
35
|
strict?: S;
|
|
38
36
|
};
|
|
39
|
-
type GenerateMainJson<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainJsonOptions<O, S>) => unknown;
|
|
40
|
-
//#endregion
|
|
41
|
-
export { DateLike, DeepOmit, ExtraFields, GenerateMainJson, GenerateMainJsonOptions, GenerateMainXml, GenerateMainXmlOptions, IsPlainObject, ParseMainOptions, Requirable, Strict, XmlStylesheet };
|
|
37
|
+
export type GenerateMainJson<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainJsonOptions<O, S>) => unknown;
|
|
38
|
+
//#endregion
|
package/dist/common/types.d.ts
CHANGED
|
@@ -8,19 +8,17 @@ type HasMarker<T> = [Extract<T, {
|
|
|
8
8
|
}>] extends [never] ? false : true;
|
|
9
9
|
type Optional<T> = { [K in keyof T]-?: object extends Pick<T, K> ? K : never; }[keyof T];
|
|
10
10
|
type Marked<T> = { [K in keyof T]-?: HasMarker<T[K]> extends true ? K : never; }[keyof T];
|
|
11
|
-
type Strict<T, S extends boolean> = Simplify<S extends true ? { [K in Exclude<keyof T, Optional<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T>]?: Unwrap<T[K]>; } : { [K in Exclude<keyof T, Optional<T> | Marked<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T> | Marked<T>]?: Unwrap<T[K]>; }>;
|
|
12
|
-
type
|
|
13
|
-
type DeepOmit<T, K extends string> = T extends Array<infer U> ? Array<DeepOmit<U, K>> : IsPlainObject<T> extends true ? Pick<{ [P in keyof T]: DeepOmit<T[P], K>; }, Exclude<keyof T, K>> : T;
|
|
14
|
-
type Requirable<T> = T | {
|
|
11
|
+
export type Strict<T, S extends boolean> = Simplify<S extends true ? { [K in Exclude<keyof T, Optional<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T>]?: Unwrap<T[K]>; } : { [K in Exclude<keyof T, Optional<T> | Marked<T>>]-?: Unwrap<T[K]>; } & { [K in Optional<T> | Marked<T>]?: Unwrap<T[K]>; }>;
|
|
12
|
+
export type Requirable<T> = T | {
|
|
15
13
|
__requirable: T;
|
|
16
14
|
};
|
|
17
|
-
type DateLike = Date | string;
|
|
18
|
-
type ExtraFields<F extends ReadonlyArray<string>, V = unknown> = { [K in F[number]]?: V; };
|
|
19
|
-
type ParseMainOptions<TDate> = {
|
|
15
|
+
export type DateLike = Date | string;
|
|
16
|
+
export type ExtraFields<F extends ReadonlyArray<string>, V = unknown> = { [K in F[number]]?: V; };
|
|
17
|
+
export type ParseMainOptions<TDate> = {
|
|
20
18
|
maxItems?: number;
|
|
21
19
|
parseDateFn?: (raw: string) => TDate;
|
|
22
20
|
};
|
|
23
|
-
type XmlStylesheet = {
|
|
21
|
+
export type XmlStylesheet = {
|
|
24
22
|
type: string;
|
|
25
23
|
href: string;
|
|
26
24
|
title?: string;
|
|
@@ -28,14 +26,13 @@ type XmlStylesheet = {
|
|
|
28
26
|
charset?: string;
|
|
29
27
|
alternate?: boolean;
|
|
30
28
|
};
|
|
31
|
-
type GenerateMainXmlOptions<O, S extends boolean> = O & {
|
|
29
|
+
export type GenerateMainXmlOptions<O, S extends boolean> = O & {
|
|
32
30
|
strict?: S;
|
|
33
31
|
stylesheets?: Array<XmlStylesheet>;
|
|
34
32
|
};
|
|
35
|
-
type GenerateMainXml<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainXmlOptions<O, S>) => string;
|
|
36
|
-
type GenerateMainJsonOptions<O, S extends boolean> = O & {
|
|
33
|
+
export type GenerateMainXml<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainXmlOptions<O, S>) => string;
|
|
34
|
+
export type GenerateMainJsonOptions<O, S extends boolean> = O & {
|
|
37
35
|
strict?: S;
|
|
38
36
|
};
|
|
39
|
-
type GenerateMainJson<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainJsonOptions<O, S>) => unknown;
|
|
40
|
-
//#endregion
|
|
41
|
-
export { DateLike, DeepOmit, ExtraFields, GenerateMainJson, GenerateMainJsonOptions, GenerateMainXml, GenerateMainXmlOptions, IsPlainObject, ParseMainOptions, Requirable, Strict, XmlStylesheet };
|
|
37
|
+
export type GenerateMainJson<LV, SV, O = Record<string, unknown>> = <S extends boolean = false>(value: S extends true ? SV : LV, options?: GenerateMainJsonOptions<O, S>) => unknown;
|
|
38
|
+
//#endregion
|
package/dist/common/utils.cjs
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
const require_is = require("../node_modules/trousse/dist/is.cjs");
|
|
2
2
|
const require_coercions = require("../node_modules/trousse/dist/coercions.cjs");
|
|
3
3
|
const require_json = require("../node_modules/trousse/dist/json.cjs");
|
|
4
|
+
const require_objects = require("../node_modules/trousse/dist/objects.cjs");
|
|
4
5
|
let entities = require("entities");
|
|
5
6
|
//#region src/common/utils.ts
|
|
6
7
|
const isNonEmptyStringOrNumber = (value) => {
|
|
@@ -21,23 +22,6 @@ const retrieveRdfResourceOrText = (value, parse) => {
|
|
|
21
22
|
}
|
|
22
23
|
return parse(retrieveText(value));
|
|
23
24
|
};
|
|
24
|
-
const trimObject = (object) => {
|
|
25
|
-
let hasPresent = false;
|
|
26
|
-
let hasAbsent = false;
|
|
27
|
-
for (const key in object) {
|
|
28
|
-
if (require_is.isPresent(object[key])) hasPresent = true;
|
|
29
|
-
else hasAbsent = true;
|
|
30
|
-
if (hasPresent && hasAbsent) break;
|
|
31
|
-
}
|
|
32
|
-
if (!hasPresent) return;
|
|
33
|
-
if (!hasAbsent) return object;
|
|
34
|
-
const result = {};
|
|
35
|
-
for (const key in object) {
|
|
36
|
-
const value = object[key];
|
|
37
|
-
if (require_is.isPresent(value)) result[key] = value;
|
|
38
|
-
}
|
|
39
|
-
return result;
|
|
40
|
-
};
|
|
41
25
|
const trimArray = (value, parse) => {
|
|
42
26
|
if (!Array.isArray(value) || value.length === 0) return;
|
|
43
27
|
if (!parse) {
|
|
@@ -166,7 +150,7 @@ const generateCsvOf = (value, generate) => {
|
|
|
166
150
|
return trimArray(value, generate)?.join();
|
|
167
151
|
};
|
|
168
152
|
const generateXmlStylesheet = (stylesheet) => {
|
|
169
|
-
const generated = trimObject({
|
|
153
|
+
const generated = require_objects.trimObject({
|
|
170
154
|
type: generatePlainString(stylesheet.type),
|
|
171
155
|
href: generatePlainString(stylesheet.href),
|
|
172
156
|
title: generatePlainString(stylesheet.title),
|
|
@@ -423,4 +407,3 @@ exports.parseYesNoBoolean = parseYesNoBoolean;
|
|
|
423
407
|
exports.retrieveRdfResourceOrText = retrieveRdfResourceOrText;
|
|
424
408
|
exports.retrieveText = retrieveText;
|
|
425
409
|
exports.trimArray = trimArray;
|
|
426
|
-
exports.trimObject = trimObject;
|
package/dist/common/utils.js
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { isNonEmptyString, isNumber, isPlainObject, isPresent } from "../node_modules/trousse/dist/is.js";
|
|
2
2
|
import { coerceBoolean, coerceNumber, coerceSingular } from "../node_modules/trousse/dist/coercions.js";
|
|
3
3
|
import { isJsonLike } from "../node_modules/trousse/dist/json.js";
|
|
4
|
+
import { trimObject } from "../node_modules/trousse/dist/objects.js";
|
|
4
5
|
import { decodeHTML } from "entities";
|
|
5
6
|
//#region src/common/utils.ts
|
|
6
7
|
const isNonEmptyStringOrNumber = (value) => {
|
|
@@ -21,23 +22,6 @@ const retrieveRdfResourceOrText = (value, parse) => {
|
|
|
21
22
|
}
|
|
22
23
|
return parse(retrieveText(value));
|
|
23
24
|
};
|
|
24
|
-
const trimObject = (object) => {
|
|
25
|
-
let hasPresent = false;
|
|
26
|
-
let hasAbsent = false;
|
|
27
|
-
for (const key in object) {
|
|
28
|
-
if (isPresent(object[key])) hasPresent = true;
|
|
29
|
-
else hasAbsent = true;
|
|
30
|
-
if (hasPresent && hasAbsent) break;
|
|
31
|
-
}
|
|
32
|
-
if (!hasPresent) return;
|
|
33
|
-
if (!hasAbsent) return object;
|
|
34
|
-
const result = {};
|
|
35
|
-
for (const key in object) {
|
|
36
|
-
const value = object[key];
|
|
37
|
-
if (isPresent(value)) result[key] = value;
|
|
38
|
-
}
|
|
39
|
-
return result;
|
|
40
|
-
};
|
|
41
25
|
const trimArray = (value, parse) => {
|
|
42
26
|
if (!Array.isArray(value) || value.length === 0) return;
|
|
43
27
|
if (!parse) {
|
|
@@ -389,4 +373,4 @@ const parseJsonObject = (value) => {
|
|
|
389
373
|
} catch {}
|
|
390
374
|
};
|
|
391
375
|
//#endregion
|
|
392
|
-
export { createNamespaceResolver, detectNamespaces, generateBoolean, generateCdataString, generateCsvOf, generateNamespaceAttrs, generateNumber, generatePlainString, generateRdfResource, generateRfc3339Date, generateRfc822Date, generateTextOrCdataString, generateXml, generateXmlStylesheet, generateYesNoBoolean, hasEntities, isNonEmptyStringOrNumber, isXmlAttributeKey, limitArray, parseArray, parseArrayOf, parseBoolean, parseCsvOf, parseDate, parseJsonObject, parseNumber, parseSingular, parseSingularOf, parseString, parseVerbatimString, parseYesNoBoolean, retrieveRdfResourceOrText, retrieveText, trimArray
|
|
376
|
+
export { createNamespaceResolver, detectNamespaces, generateBoolean, generateCdataString, generateCsvOf, generateNamespaceAttrs, generateNumber, generatePlainString, generateRdfResource, generateRfc3339Date, generateRfc822Date, generateTextOrCdataString, generateXml, generateXmlStylesheet, generateYesNoBoolean, hasEntities, isNonEmptyStringOrNumber, isXmlAttributeKey, limitArray, parseArray, parseArrayOf, parseBoolean, parseCsvOf, parseDate, parseJsonObject, parseNumber, parseSingular, parseSingularOf, parseString, parseVerbatimString, parseYesNoBoolean, retrieveRdfResourceOrText, retrieveText, trimArray };
|
|
@@ -22,7 +22,7 @@ import { WfwNs } from "../../../namespaces/wfw/common/types.cjs";
|
|
|
22
22
|
import { XmlNs } from "../../../namespaces/xml/common/types.cjs";
|
|
23
23
|
import { YtNs } from "../../../namespaces/yt/common/types.cjs";
|
|
24
24
|
//#region src/feeds/atom/common/types.d.ts
|
|
25
|
-
declare namespace AtomFeed {
|
|
25
|
+
export declare namespace AtomFeed {
|
|
26
26
|
type Text = {
|
|
27
27
|
value: string;
|
|
28
28
|
type?: string;
|
|
@@ -137,5 +137,4 @@ declare namespace AtomFeed {
|
|
|
137
137
|
xml?: XmlNs.ItemOrFeed;
|
|
138
138
|
}, TStrict>;
|
|
139
139
|
}
|
|
140
|
-
//#endregion
|
|
141
|
-
export { AtomFeed };
|
|
140
|
+
//#endregion
|
|
@@ -22,7 +22,7 @@ import { WfwNs } from "../../../namespaces/wfw/common/types.js";
|
|
|
22
22
|
import { XmlNs } from "../../../namespaces/xml/common/types.js";
|
|
23
23
|
import { YtNs } from "../../../namespaces/yt/common/types.js";
|
|
24
24
|
//#region src/feeds/atom/common/types.d.ts
|
|
25
|
-
declare namespace AtomFeed {
|
|
25
|
+
export declare namespace AtomFeed {
|
|
26
26
|
type Text = {
|
|
27
27
|
value: string;
|
|
28
28
|
type?: string;
|
|
@@ -137,5 +137,4 @@ declare namespace AtomFeed {
|
|
|
137
137
|
xml?: XmlNs.ItemOrFeed;
|
|
138
138
|
}, TStrict>;
|
|
139
139
|
}
|
|
140
|
-
//#endregion
|
|
141
|
-
export { AtomFeed };
|
|
140
|
+
//#endregion
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { DateLike, GenerateMainXml } from "../../../common/types.cjs";
|
|
2
2
|
import { AtomFeed } from "../common/types.cjs";
|
|
3
3
|
//#region src/feeds/atom/generate/index.d.ts
|
|
4
|
-
declare const generate: GenerateMainXml<AtomFeed.Feed<DateLike>, AtomFeed.Feed<Date, true>>;
|
|
5
|
-
//#endregion
|
|
6
|
-
export { generate };
|
|
4
|
+
export declare const generate: GenerateMainXml<AtomFeed.Feed<DateLike>, AtomFeed.Feed<Date, true>>;
|
|
5
|
+
//#endregion
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { DateLike, GenerateMainXml } from "../../../common/types.js";
|
|
2
2
|
import { AtomFeed } from "../common/types.js";
|
|
3
3
|
//#region src/feeds/atom/generate/index.d.ts
|
|
4
|
-
declare const generate: GenerateMainXml<AtomFeed.Feed<DateLike>, AtomFeed.Feed<Date, true>>;
|
|
5
|
-
//#endregion
|
|
6
|
-
export { generate };
|
|
4
|
+
export declare const generate: GenerateMainXml<AtomFeed.Feed<DateLike>, AtomFeed.Feed<Date, true>>;
|
|
5
|
+
//#endregion
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
const require_is = require("../../../node_modules/trousse/dist/is.cjs");
|
|
2
2
|
const require_locales = require("../../../node_modules/trousse/dist/locales.cjs");
|
|
3
|
+
const require_objects = require("../../../node_modules/trousse/dist/objects.cjs");
|
|
3
4
|
const require_config = require("../../../common/config.cjs");
|
|
4
5
|
const require_utils = require("../../../common/utils.cjs");
|
|
5
6
|
const require_utils$1 = require("../../../namespaces/admin/generate/utils.cjs");
|
|
@@ -69,7 +70,7 @@ const generateText = (text) => {
|
|
|
69
70
|
...typed,
|
|
70
71
|
...require_utils$21.generateItemOrFeed(text.xml)
|
|
71
72
|
};
|
|
72
|
-
return
|
|
73
|
+
return require_objects.trimObject(escapeStopNodeAttributes(value));
|
|
73
74
|
};
|
|
74
75
|
const generateContent = (content) => {
|
|
75
76
|
if (!require_is.isPlainObject(content)) return;
|
|
@@ -78,11 +79,11 @@ const generateContent = (content) => {
|
|
|
78
79
|
"@src": require_utils.generatePlainString(content.src),
|
|
79
80
|
...require_utils$21.generateItemOrFeed(content.xml)
|
|
80
81
|
};
|
|
81
|
-
return
|
|
82
|
+
return require_objects.trimObject(escapeStopNodeAttributes(value));
|
|
82
83
|
};
|
|
83
84
|
const generateLink = (link) => {
|
|
84
85
|
if (!require_is.isPlainObject(link)) return;
|
|
85
|
-
|
|
86
|
+
const value = {
|
|
86
87
|
"@href": require_utils.generatePlainString(link.href),
|
|
87
88
|
"@rel": require_utils.generatePlainString(link.rel),
|
|
88
89
|
"@type": require_utils.generatePlainString(link.type),
|
|
@@ -90,38 +91,42 @@ const generateLink = (link) => {
|
|
|
90
91
|
"@title": require_utils.generatePlainString(link.title),
|
|
91
92
|
"@length": require_utils.generateNumber(link.length),
|
|
92
93
|
...require_utils$18.generateLink(link.thr)
|
|
93
|
-
}
|
|
94
|
+
};
|
|
95
|
+
return require_objects.trimObject(value);
|
|
94
96
|
};
|
|
95
97
|
const generatePerson = (person, options) => {
|
|
96
98
|
if (!require_is.isPlainObject(person)) return;
|
|
97
99
|
const key = createNamespaceSetter(options?.prefix);
|
|
98
|
-
|
|
100
|
+
const value = {
|
|
99
101
|
[key("name")]: require_utils.generateCdataString(person.name),
|
|
100
102
|
[key("uri")]: require_utils.generateCdataString(person.uri),
|
|
101
103
|
[key("email")]: require_utils.generateCdataString(person.email),
|
|
102
104
|
...require_utils$3.generateAuthor(person.arxiv)
|
|
103
|
-
}
|
|
105
|
+
};
|
|
106
|
+
return require_objects.trimObject(value);
|
|
104
107
|
};
|
|
105
108
|
const generateCategory = (category) => {
|
|
106
109
|
if (!require_is.isPlainObject(category)) return;
|
|
107
|
-
|
|
110
|
+
const value = {
|
|
108
111
|
"@term": require_utils.generatePlainString(category.term),
|
|
109
112
|
"@scheme": require_utils.generatePlainString(category.scheme),
|
|
110
113
|
"@label": require_utils.generatePlainString(category.label)
|
|
111
|
-
}
|
|
114
|
+
};
|
|
115
|
+
return require_objects.trimObject(value);
|
|
112
116
|
};
|
|
113
117
|
const generateGenerator = (generator) => {
|
|
114
118
|
if (!require_is.isPlainObject(generator)) return;
|
|
115
|
-
|
|
119
|
+
const value = {
|
|
116
120
|
...require_utils.generateTextOrCdataString(generator.text),
|
|
117
121
|
"@uri": require_utils.generatePlainString(generator.uri),
|
|
118
122
|
"@version": require_utils.generatePlainString(generator.version)
|
|
119
|
-
}
|
|
123
|
+
};
|
|
124
|
+
return require_objects.trimObject(value);
|
|
120
125
|
};
|
|
121
126
|
const generateSource = (source, options) => {
|
|
122
127
|
if (!require_is.isPlainObject(source)) return;
|
|
123
128
|
const key = createNamespaceSetter(options?.prefix);
|
|
124
|
-
|
|
129
|
+
const value = {
|
|
125
130
|
[key("author")]: require_utils.trimArray(source.authors, (author) => generatePerson(author, options)),
|
|
126
131
|
[key("category")]: require_utils.trimArray(source.categories, (category) => generateCategory(category, options)),
|
|
127
132
|
[key("contributor")]: require_utils.trimArray(source.contributors, (contributor) => generatePerson(contributor, options)),
|
|
@@ -134,13 +139,14 @@ const generateSource = (source, options) => {
|
|
|
134
139
|
[key("subtitle")]: generateText(source.subtitle),
|
|
135
140
|
[key("title")]: generateText(source.title),
|
|
136
141
|
[key("updated")]: require_utils.generateRfc3339Date(source.updated)
|
|
137
|
-
}
|
|
142
|
+
};
|
|
143
|
+
return require_objects.trimObject(value);
|
|
138
144
|
};
|
|
139
145
|
const generateEntry = (entry, options) => {
|
|
140
146
|
if (!require_is.isPlainObject(entry)) return;
|
|
141
147
|
const key = createNamespaceSetter(options?.prefix);
|
|
142
|
-
const
|
|
143
|
-
[key("author")]: require_utils.trimArray(entry.authors, generatePerson),
|
|
148
|
+
const value = {
|
|
149
|
+
[key("author")]: require_utils.trimArray(entry.authors, (author) => generatePerson(author, options)),
|
|
144
150
|
[key("category")]: require_utils.trimArray(entry.categories, generateCategory),
|
|
145
151
|
[key("content")]: generateContent(entry.content),
|
|
146
152
|
[key("contributor")]: require_utils.trimArray(entry.contributors, (contributor) => generatePerson(contributor, options)),
|
|
@@ -152,10 +158,10 @@ const generateEntry = (entry, options) => {
|
|
|
152
158
|
[key("summary")]: generateText(entry.summary),
|
|
153
159
|
[key("title")]: generateText(entry.title),
|
|
154
160
|
[key("updated")]: require_utils.generateRfc3339Date(entry.updated)
|
|
155
|
-
}
|
|
156
|
-
|
|
161
|
+
};
|
|
162
|
+
const trimmedValue = require_objects.trimObject(value);
|
|
157
163
|
if (options?.asNamespace) return trimmedValue;
|
|
158
|
-
|
|
164
|
+
const fullValue = {
|
|
159
165
|
...trimmedValue,
|
|
160
166
|
...require_utils$2.generateEntry(entry.app),
|
|
161
167
|
...require_utils$3.generateEntry(entry.arxiv),
|
|
@@ -177,11 +183,12 @@ const generateEntry = (entry, options) => {
|
|
|
177
183
|
...require_utils$19.generateItem(entry.trackback),
|
|
178
184
|
...require_utils$21.generateItemOrFeed(entry.xml)
|
|
179
185
|
};
|
|
186
|
+
return require_objects.trimObject(fullValue);
|
|
180
187
|
};
|
|
181
188
|
const generateFeed = (feed, options) => {
|
|
182
189
|
if (!require_is.isPlainObject(feed)) return;
|
|
183
190
|
const key = createNamespaceSetter(options?.prefix);
|
|
184
|
-
const
|
|
191
|
+
const feedValue = {
|
|
185
192
|
[key("author")]: require_utils.trimArray(feed.authors, (author) => generatePerson(author, options)),
|
|
186
193
|
[key("category")]: require_utils.trimArray(feed.categories, (category) => generateCategory(category, options)),
|
|
187
194
|
[key("contributor")]: require_utils.trimArray(feed.contributors, (contributor) => generatePerson(contributor, options)),
|
|
@@ -194,14 +201,18 @@ const generateFeed = (feed, options) => {
|
|
|
194
201
|
[key("subtitle")]: generateText(feed.subtitle),
|
|
195
202
|
[key("title")]: generateText(feed.title),
|
|
196
203
|
[key("updated")]: require_utils.generateRfc3339Date(feed.updated)
|
|
197
|
-
}
|
|
198
|
-
const
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
204
|
+
};
|
|
205
|
+
const valueFeed = require_objects.trimObject(feedValue);
|
|
206
|
+
const entriesValue = { [key("entry")]: require_utils.trimArray(feed.entries, (entry) => generateEntry(entry, options)) };
|
|
207
|
+
const valueEntries = require_objects.trimObject(entriesValue);
|
|
208
|
+
if (options?.asNamespace) {
|
|
209
|
+
if (!valueFeed && !valueEntries) return;
|
|
210
|
+
return { feed: {
|
|
211
|
+
...valueFeed,
|
|
212
|
+
...valueEntries
|
|
213
|
+
} };
|
|
214
|
+
}
|
|
215
|
+
const fullValue = require_objects.trimObject({
|
|
205
216
|
...valueFeed,
|
|
206
217
|
...require_utils$4.generateItemOrFeed(feed.cc),
|
|
207
218
|
...require_utils$6.generateItemOrFeed(feed.dc),
|
|
@@ -219,11 +230,12 @@ const generateFeed = (feed, options) => {
|
|
|
219
230
|
...require_utils$14.generateFeed(feed.pingback),
|
|
220
231
|
...require_utils$21.generateItemOrFeed(feed.xml),
|
|
221
232
|
...valueEntries
|
|
222
|
-
};
|
|
233
|
+
});
|
|
234
|
+
if (!fullValue) return;
|
|
223
235
|
return { feed: {
|
|
224
236
|
"@xmlns": "http://www.w3.org/2005/Atom",
|
|
225
|
-
...require_utils.generateNamespaceAttrs({ value:
|
|
226
|
-
...
|
|
237
|
+
...require_utils.generateNamespaceAttrs({ value: fullValue }, require_config.namespaceUris),
|
|
238
|
+
...fullValue
|
|
227
239
|
} };
|
|
228
240
|
};
|
|
229
241
|
//#endregion
|