feedsmith 2.0.0 → 2.1.1

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 (160) hide show
  1. package/README.md +7 -4
  2. package/dist/index.cjs +3619 -0
  3. package/dist/index.d.cts +1016 -0
  4. package/dist/index.d.ts +1016 -19
  5. package/dist/index.js +3581 -14
  6. package/package.json +19 -11
  7. package/dist/common/config.d.ts +0 -23
  8. package/dist/common/config.js +0 -43
  9. package/dist/common/parse.d.ts +0 -19
  10. package/dist/common/parse.js +0 -24
  11. package/dist/common/types.d.ts +0 -41
  12. package/dist/common/types.js +0 -1
  13. package/dist/common/utils.d.ts +0 -37
  14. package/dist/common/utils.js +0 -477
  15. package/dist/feeds/atom/common/types.d.ts +0 -103
  16. package/dist/feeds/atom/common/types.js +0 -2
  17. package/dist/feeds/atom/detect/index.d.ts +0 -1
  18. package/dist/feeds/atom/detect/index.js +0 -13
  19. package/dist/feeds/atom/generate/config.d.ts +0 -2
  20. package/dist/feeds/atom/generate/config.js +0 -5
  21. package/dist/feeds/atom/generate/index.d.ts +0 -3
  22. package/dist/feeds/atom/generate/index.js +0 -10
  23. package/dist/feeds/atom/generate/utils.d.ts +0 -11
  24. package/dist/feeds/atom/generate/utils.js +0 -181
  25. package/dist/feeds/atom/parse/config.d.ts +0 -3
  26. package/dist/feeds/atom/parse/config.js +0 -68
  27. package/dist/feeds/atom/parse/index.d.ts +0 -3
  28. package/dist/feeds/atom/parse/index.js +0 -18
  29. package/dist/feeds/atom/parse/utils.d.ts +0 -16
  30. package/dist/feeds/atom/parse/utils.js +0 -206
  31. package/dist/feeds/json/common/types.d.ts +0 -53
  32. package/dist/feeds/json/common/types.js +0 -2
  33. package/dist/feeds/json/detect/index.d.ts +0 -1
  34. package/dist/feeds/json/detect/index.js +0 -16
  35. package/dist/feeds/json/generate/index.d.ts +0 -3
  36. package/dist/feeds/json/generate/index.js +0 -4
  37. package/dist/feeds/json/generate/utils.d.ts +0 -1971
  38. package/dist/feeds/json/generate/utils.js +0 -17
  39. package/dist/feeds/json/parse/index.d.ts +0 -3
  40. package/dist/feeds/json/parse/index.js +0 -13
  41. package/dist/feeds/json/parse/utils.d.ts +0 -9
  42. package/dist/feeds/json/parse/utils.js +0 -114
  43. package/dist/feeds/rdf/common/types.d.ts +0 -48
  44. package/dist/feeds/rdf/common/types.js +0 -2
  45. package/dist/feeds/rdf/detect/index.d.ts +0 -1
  46. package/dist/feeds/rdf/detect/index.js +0 -14
  47. package/dist/feeds/rdf/parse/config.d.ts +0 -3
  48. package/dist/feeds/rdf/parse/config.js +0 -22
  49. package/dist/feeds/rdf/parse/index.d.ts +0 -3
  50. package/dist/feeds/rdf/parse/index.js +0 -18
  51. package/dist/feeds/rdf/parse/utils.d.ts +0 -10
  52. package/dist/feeds/rdf/parse/utils.js +0 -90
  53. package/dist/feeds/rss/common/types.d.ts +0 -111
  54. package/dist/feeds/rss/common/types.js +0 -2
  55. package/dist/feeds/rss/detect/index.d.ts +0 -1
  56. package/dist/feeds/rss/detect/index.js +0 -13
  57. package/dist/feeds/rss/generate/config.d.ts +0 -2
  58. package/dist/feeds/rss/generate/config.js +0 -5
  59. package/dist/feeds/rss/generate/index.d.ts +0 -3
  60. package/dist/feeds/rss/generate/index.js +0 -10
  61. package/dist/feeds/rss/generate/utils.d.ts +0 -14
  62. package/dist/feeds/rss/generate/utils.js +0 -181
  63. package/dist/feeds/rss/parse/config.d.ts +0 -3
  64. package/dist/feeds/rss/parse/config.js +0 -49
  65. package/dist/feeds/rss/parse/index.d.ts +0 -3
  66. package/dist/feeds/rss/parse/index.js +0 -18
  67. package/dist/feeds/rss/parse/utils.d.ts +0 -15
  68. package/dist/feeds/rss/parse/utils.js +0 -163
  69. package/dist/namespaces/atom/common/types.d.ts +0 -4
  70. package/dist/namespaces/atom/common/types.js +0 -2
  71. package/dist/namespaces/atom/generate/utils.d.ts +0 -4
  72. package/dist/namespaces/atom/generate/utils.js +0 -7
  73. package/dist/namespaces/atom/parse/utils.d.ts +0 -4
  74. package/dist/namespaces/atom/parse/utils.js +0 -7
  75. package/dist/namespaces/content/common/types.d.ts +0 -3
  76. package/dist/namespaces/content/common/types.js +0 -2
  77. package/dist/namespaces/content/generate/utils.d.ts +0 -3
  78. package/dist/namespaces/content/generate/utils.js +0 -10
  79. package/dist/namespaces/content/parse/utils.d.ts +0 -3
  80. package/dist/namespaces/content/parse/utils.js +0 -10
  81. package/dist/namespaces/dc/common/types.d.ts +0 -18
  82. package/dist/namespaces/dc/common/types.js +0 -2
  83. package/dist/namespaces/dc/generate/utils.d.ts +0 -3
  84. package/dist/namespaces/dc/generate/utils.js +0 -24
  85. package/dist/namespaces/dc/parse/utils.d.ts +0 -3
  86. package/dist/namespaces/dc/parse/utils.js +0 -24
  87. package/dist/namespaces/dcterms/common/types.d.ts +0 -58
  88. package/dist/namespaces/dcterms/common/types.js +0 -2
  89. package/dist/namespaces/dcterms/generate/utils.d.ts +0 -3
  90. package/dist/namespaces/dcterms/generate/utils.js +0 -64
  91. package/dist/namespaces/dcterms/parse/utils.d.ts +0 -3
  92. package/dist/namespaces/dcterms/parse/utils.js +0 -64
  93. package/dist/namespaces/georss/common/types.d.ts +0 -26
  94. package/dist/namespaces/georss/common/types.js +0 -2
  95. package/dist/namespaces/georss/generate/utils.d.ts +0 -11
  96. package/dist/namespaces/georss/generate/utils.js +0 -60
  97. package/dist/namespaces/georss/parse/utils.d.ts +0 -11
  98. package/dist/namespaces/georss/parse/utils.js +0 -68
  99. package/dist/namespaces/itunes/common/types.d.ts +0 -44
  100. package/dist/namespaces/itunes/common/types.js +0 -2
  101. package/dist/namespaces/itunes/generate/utils.d.ts +0 -7
  102. package/dist/namespaces/itunes/generate/utils.js +0 -70
  103. package/dist/namespaces/itunes/parse/utils.d.ts +0 -9
  104. package/dist/namespaces/itunes/parse/utils.js +0 -99
  105. package/dist/namespaces/media/common/types.d.ts +0 -172
  106. package/dist/namespaces/media/common/types.js +0 -2
  107. package/dist/namespaces/media/generate/utils.d.ts +0 -33
  108. package/dist/namespaces/media/generate/utils.js +0 -350
  109. package/dist/namespaces/media/parse/utils.d.ts +0 -35
  110. package/dist/namespaces/media/parse/utils.js +0 -344
  111. package/dist/namespaces/podcast/common/types.d.ts +0 -182
  112. package/dist/namespaces/podcast/common/types.js +0 -2
  113. package/dist/namespaces/podcast/generate/utils.d.ts +0 -32
  114. package/dist/namespaces/podcast/generate/utils.js +0 -362
  115. package/dist/namespaces/podcast/parse/utils.d.ts +0 -31
  116. package/dist/namespaces/podcast/parse/utils.js +0 -330
  117. package/dist/namespaces/slash/common/types.d.ts +0 -7
  118. package/dist/namespaces/slash/common/types.js +0 -2
  119. package/dist/namespaces/slash/generate/utils.d.ts +0 -3
  120. package/dist/namespaces/slash/generate/utils.js +0 -13
  121. package/dist/namespaces/slash/parse/utils.d.ts +0 -4
  122. package/dist/namespaces/slash/parse/utils.js +0 -16
  123. package/dist/namespaces/sy/common/types.d.ts +0 -6
  124. package/dist/namespaces/sy/common/types.js +0 -2
  125. package/dist/namespaces/sy/generate/utils.d.ts +0 -3
  126. package/dist/namespaces/sy/generate/utils.js +0 -12
  127. package/dist/namespaces/sy/parse/utils.d.ts +0 -3
  128. package/dist/namespaces/sy/parse/utils.js +0 -12
  129. package/dist/namespaces/thr/common/types.d.ts +0 -15
  130. package/dist/namespaces/thr/common/types.js +0 -2
  131. package/dist/namespaces/thr/generate/utils.d.ts +0 -5
  132. package/dist/namespaces/thr/generate/utils.js +0 -33
  133. package/dist/namespaces/thr/parse/utils.d.ts +0 -5
  134. package/dist/namespaces/thr/parse/utils.js +0 -33
  135. package/dist/namespaces/wfw/common/types.d.ts +0 -4
  136. package/dist/namespaces/wfw/common/types.js +0 -2
  137. package/dist/namespaces/wfw/generate/utils.d.ts +0 -3
  138. package/dist/namespaces/wfw/generate/utils.js +0 -11
  139. package/dist/namespaces/wfw/parse/utils.d.ts +0 -3
  140. package/dist/namespaces/wfw/parse/utils.js +0 -11
  141. package/dist/namespaces/yt/common/types.d.ts +0 -8
  142. package/dist/namespaces/yt/common/types.js +0 -2
  143. package/dist/namespaces/yt/generate/utils.d.ts +0 -4
  144. package/dist/namespaces/yt/generate/utils.js +0 -21
  145. package/dist/namespaces/yt/parse/utils.d.ts +0 -4
  146. package/dist/namespaces/yt/parse/utils.js +0 -21
  147. package/dist/opml/common/types.d.ts +0 -39
  148. package/dist/opml/common/types.js +0 -2
  149. package/dist/opml/generate/config.d.ts +0 -2
  150. package/dist/opml/generate/config.js +0 -5
  151. package/dist/opml/generate/index.d.ts +0 -3
  152. package/dist/opml/generate/index.js +0 -10
  153. package/dist/opml/generate/utils.d.ts +0 -6
  154. package/dist/opml/generate/utils.js +0 -66
  155. package/dist/opml/parse/config.d.ts +0 -3
  156. package/dist/opml/parse/config.js +0 -22
  157. package/dist/opml/parse/index.d.ts +0 -3
  158. package/dist/opml/parse/index.js +0 -10
  159. package/dist/opml/parse/utils.d.ts +0 -6
  160. package/dist/opml/parse/utils.js +0 -63
@@ -1,17 +0,0 @@
1
- import { generateRfc3339Date, trimArray, trimObject } from '../../../common/utils.js';
2
- export const generateItem = (item) => {
3
- const value = {
4
- ...item,
5
- date_published: item.date_published ? generateRfc3339Date(item.date_published) : undefined,
6
- date_modified: item.date_modified ? generateRfc3339Date(item.date_modified) : undefined,
7
- };
8
- return trimObject(value);
9
- };
10
- export const generateFeed = (feed) => {
11
- const value = {
12
- version: 'https://jsonfeed.org/version/1.1',
13
- ...feed,
14
- items: trimArray(feed.items, generateItem),
15
- };
16
- return trimObject(value);
17
- };
@@ -1,3 +0,0 @@
1
- import type { DeepPartial } from '../../../common/types.js';
2
- import type { Feed } from '../common/types.js';
3
- export declare const parse: (value: unknown) => DeepPartial<Feed<string>>;
@@ -1,13 +0,0 @@
1
- import { locales } from '../../../common/config.js';
2
- import { detectJsonFeed } from '../../../index.js';
3
- import { parseFeed } from './utils.js';
4
- export const parse = (value) => {
5
- if (!detectJsonFeed(value)) {
6
- throw new Error(locales.invalid);
7
- }
8
- const parsed = parseFeed(value);
9
- if (!parsed) {
10
- throw new Error(locales.invalid);
11
- }
12
- return parsed;
13
- };
@@ -1,9 +0,0 @@
1
- import type { ParsePartialFunction } from '../../../common/types.js';
2
- import type { Attachment, Author, Feed, Hub, Item } from '../common/types.js';
3
- export declare const createCaseInsensitiveGetter: (value: Record<string, unknown>) => (requestedKey: string) => unknown;
4
- export declare const parseAuthor: ParsePartialFunction<Author>;
5
- export declare const retrieveAuthors: ParsePartialFunction<Array<Author>>;
6
- export declare const parseAttachment: ParsePartialFunction<Attachment>;
7
- export declare const parseItem: ParsePartialFunction<Item<string>>;
8
- export declare const parseHub: ParsePartialFunction<Hub>;
9
- export declare const parseFeed: ParsePartialFunction<Feed<string>>;
@@ -1,114 +0,0 @@
1
- import { isNonEmptyStringOrNumber, isObject, parseArrayOf, parseBoolean, parseDate, parseNumber, parseSingularOf, parseString, trimObject, } from '../../../common/utils.js';
2
- export const createCaseInsensitiveGetter = (value) => {
3
- return (requestedKey) => {
4
- if (requestedKey in value) {
5
- return value[requestedKey];
6
- }
7
- const lowerKey = requestedKey.toLowerCase();
8
- for (const key in value) {
9
- if (key.toLowerCase() === lowerKey) {
10
- return value[key];
11
- }
12
- }
13
- };
14
- };
15
- export const parseAuthor = (value) => {
16
- if (isObject(value)) {
17
- const get = createCaseInsensitiveGetter(value);
18
- const author = {
19
- name: parseSingularOf(get('name'), parseString),
20
- url: parseSingularOf(get('url'), parseString),
21
- avatar: parseSingularOf(get('avatar'), parseString),
22
- };
23
- return trimObject(author);
24
- }
25
- if (isNonEmptyStringOrNumber(value)) {
26
- const author = {
27
- name: parseString(value),
28
- };
29
- return trimObject(author);
30
- }
31
- };
32
- export const retrieveAuthors = (value) => {
33
- if (!isObject(value)) {
34
- return;
35
- }
36
- // Regardless of the JSON Feed version, the 'authors' property is returned in the item/feed.
37
- // Some feeds use author/authors incorrectly based on the feed version, so this function helps
38
- // to unify those into one value.
39
- const get = createCaseInsensitiveGetter(value);
40
- const parsedAuthors = parseArrayOf(get('authors'), parseAuthor);
41
- const parsedAuthor = parseArrayOf(get('author'), parseAuthor);
42
- return parsedAuthors?.length ? parsedAuthors : parsedAuthor;
43
- };
44
- export const parseAttachment = (value) => {
45
- if (!isObject(value)) {
46
- return;
47
- }
48
- const get = createCaseInsensitiveGetter(value);
49
- const attachment = {
50
- url: parseSingularOf(get('url'), parseString),
51
- mime_type: parseSingularOf(get('mime_type'), parseString),
52
- title: parseSingularOf(get('title'), parseString),
53
- size_in_bytes: parseSingularOf(get('size_in_bytes'), parseNumber),
54
- duration_in_seconds: parseSingularOf(get('duration_in_seconds'), parseNumber),
55
- };
56
- return trimObject(attachment);
57
- };
58
- export const parseItem = (value) => {
59
- if (!isObject(value)) {
60
- return;
61
- }
62
- const get = createCaseInsensitiveGetter(value);
63
- const item = {
64
- id: parseSingularOf(get('id'), parseString),
65
- url: parseSingularOf(get('url'), parseString),
66
- external_url: parseSingularOf(get('external_url'), parseString),
67
- title: parseSingularOf(get('title'), parseString),
68
- content_html: parseSingularOf(get('content_html'), parseString),
69
- content_text: parseSingularOf(get('content_text'), parseString),
70
- summary: parseSingularOf(get('summary'), parseString),
71
- image: parseSingularOf(get('image'), parseString),
72
- banner_image: parseSingularOf(get('banner_image'), parseString),
73
- date_published: parseSingularOf(get('date_published'), parseDate),
74
- date_modified: parseSingularOf(get('date_modified'), parseDate),
75
- tags: parseArrayOf(get('tags'), parseString),
76
- authors: retrieveAuthors(value),
77
- language: parseSingularOf(get('language'), parseString),
78
- attachments: parseArrayOf(get('attachments'), parseAttachment),
79
- };
80
- return trimObject(item);
81
- };
82
- export const parseHub = (value) => {
83
- if (!isObject(value)) {
84
- return;
85
- }
86
- const get = createCaseInsensitiveGetter(value);
87
- const hub = {
88
- type: parseSingularOf(get('type'), parseString),
89
- url: parseSingularOf(get('url'), parseString),
90
- };
91
- return trimObject(hub);
92
- };
93
- export const parseFeed = (value) => {
94
- if (!isObject(value)) {
95
- return;
96
- }
97
- const get = createCaseInsensitiveGetter(value);
98
- const feed = {
99
- title: parseSingularOf(get('title'), parseString),
100
- home_page_url: parseSingularOf(get('home_page_url'), parseString),
101
- feed_url: parseSingularOf(get('feed_url'), parseString),
102
- description: parseSingularOf(get('description'), parseString),
103
- user_comment: parseSingularOf(get('user_comment'), parseString),
104
- next_url: parseSingularOf(get('next_url'), parseString),
105
- icon: parseSingularOf(get('icon'), parseString),
106
- favicon: parseSingularOf(get('favicon'), parseString),
107
- language: parseSingularOf(get('language'), parseString),
108
- expired: parseSingularOf(get('expired'), parseBoolean),
109
- hubs: parseArrayOf(get('hubs'), parseHub),
110
- authors: retrieveAuthors(value),
111
- items: parseArrayOf(get('items'), parseItem),
112
- };
113
- return trimObject(feed);
114
- };
@@ -1,48 +0,0 @@
1
- import type { DateLike } from '../../../common/types.js';
2
- import type { Entry as AtomEntry, Feed as AtomFeed } from '../../../namespaces/atom/common/types.js';
3
- import type { Item as ContentItem } from '../../../namespaces/content/common/types.js';
4
- import type { ItemOrFeed as DcItemOrFeed } from '../../../namespaces/dc/common/types.js';
5
- import type { ItemOrFeed as DctermsItemOrFeed } from '../../../namespaces/dcterms/common/types.js';
6
- import type { ItemOrFeed as GeoRssItemOrFeed } from '../../../namespaces/georss/common/types.js';
7
- import type { ItemOrFeed as MediaItemOrFeed } from '../../../namespaces/media/common/types.js';
8
- import type { Item as SlashItem } from '../../../namespaces/slash/common/types.js';
9
- import type { Feed as SyFeed } from '../../../namespaces/sy/common/types.js';
10
- import type { Item as WfwItem } from '../../../namespaces/wfw/common/types.js';
11
- export type Image = {
12
- title: string;
13
- link: string;
14
- url?: string;
15
- };
16
- export type TextInput = {
17
- title: string;
18
- description: string;
19
- name: string;
20
- link: string;
21
- };
22
- export type Item<TDate extends DateLike> = {
23
- title: string;
24
- link: string;
25
- description?: string;
26
- atom?: AtomEntry<TDate>;
27
- content?: ContentItem;
28
- dc?: DcItemOrFeed<TDate>;
29
- dcterms?: DctermsItemOrFeed<TDate>;
30
- slash?: SlashItem;
31
- media?: MediaItemOrFeed;
32
- georss?: GeoRssItemOrFeed;
33
- wfw?: WfwItem;
34
- };
35
- export type Feed<TDate extends DateLike> = {
36
- title: string;
37
- link: string;
38
- description: string;
39
- image?: Image;
40
- items?: Array<Item<TDate>>;
41
- textInput?: TextInput;
42
- atom?: AtomFeed<TDate>;
43
- dc?: DcItemOrFeed<TDate>;
44
- dcterms?: DctermsItemOrFeed<TDate>;
45
- sy?: SyFeed<TDate>;
46
- media?: MediaItemOrFeed;
47
- georss?: GeoRssItemOrFeed;
48
- };
@@ -1,2 +0,0 @@
1
- export {};
2
- // #endregion reference
@@ -1 +0,0 @@
1
- export declare const detect: (value: unknown) => value is string;
@@ -1,14 +0,0 @@
1
- import { isNonEmptyString } from '../../../common/utils.js';
2
- export const detect = (value) => {
3
- if (!isNonEmptyString(value)) {
4
- return false;
5
- }
6
- const hasRdfElement = /(?:^|\s|>)\s*<(?:\w+:)?rdf[\s>]/im.test(value);
7
- if (!hasRdfElement) {
8
- return false;
9
- }
10
- const hasRdfNamespace = value.includes('http://www.w3.org/1999/02/22-rdf-syntax-ns#');
11
- const hasRssNamespace = value.includes('http://purl.org/rss/1.0/');
12
- const hasRdfElements = /(<(?:\w+:)?(channel|item|title|link|description)[\s>])/i.test(value);
13
- return hasRdfNamespace || hasRssNamespace || hasRdfElements;
14
- };
@@ -1,3 +0,0 @@
1
- import { XMLParser } from 'fast-xml-parser';
2
- export declare const stopNodes: string[];
3
- export declare const parser: XMLParser;
@@ -1,22 +0,0 @@
1
- import { XMLParser } from 'fast-xml-parser';
2
- import { parserConfig } from '../../../common/config.js';
3
- export const stopNodes = [
4
- 'rdf:rdf.channel.title',
5
- 'rdf:rdf.channel.link',
6
- 'rdf:rdf.channel.description',
7
- 'rdf:rdf.image.title',
8
- 'rdf:rdf.image.link',
9
- 'rdf:rdf.image.url',
10
- 'rdf:rdf.item.title',
11
- 'rdf:rdf.item.link',
12
- 'rdf:rdf.item.description',
13
- 'rdf:rdf.textinput.title',
14
- 'rdf:rdf.textinput.description',
15
- 'rdf:rdf.textinput.name',
16
- 'rdf:rdf.textinput.link',
17
- // TODO: What about the namespaces?
18
- ];
19
- export const parser = new XMLParser({
20
- ...parserConfig,
21
- stopNodes,
22
- });
@@ -1,3 +0,0 @@
1
- import type { DeepPartial } from '../../../common/types.js';
2
- import type { Feed } from '../common/types.js';
3
- export declare const parse: (value: unknown) => DeepPartial<Feed<string>>;
@@ -1,18 +0,0 @@
1
- import { locales, namespaceUrls } from '../../../common/config.js';
2
- import { createNamespaceNormalizator } from '../../../common/utils.js';
3
- import { detectRdfFeed } from '../../../index.js';
4
- import { parser } from './config.js';
5
- import { retrieveFeed } from './utils.js';
6
- export const parse = (value) => {
7
- if (!detectRdfFeed(value)) {
8
- throw new Error(locales.invalid);
9
- }
10
- const normalizeNamespaces = createNamespaceNormalizator(namespaceUrls, namespaceUrls.rdf);
11
- const object = parser.parse(value);
12
- const normalized = normalizeNamespaces(object);
13
- const parsed = retrieveFeed(normalized);
14
- if (!parsed) {
15
- throw new Error(locales.invalid);
16
- }
17
- return parsed;
18
- };
@@ -1,10 +0,0 @@
1
- import type { ParsePartialFunction } from '../../../common/types.js';
2
- import type { Feed, Image, Item, TextInput } from '../common/types.js';
3
- export declare const parseImage: ParsePartialFunction<Image>;
4
- export declare const retrieveImage: ParsePartialFunction<Image>;
5
- export declare const parseTextInput: ParsePartialFunction<TextInput>;
6
- export declare const retrieveTextInput: ParsePartialFunction<TextInput>;
7
- export declare const parseItem: ParsePartialFunction<Item<string>>;
8
- export declare const retrieveItems: ParsePartialFunction<Array<Item<string>>>;
9
- export declare const parseFeed: ParsePartialFunction<Feed<string>>;
10
- export declare const retrieveFeed: ParsePartialFunction<Feed<string>>;
@@ -1,90 +0,0 @@
1
- import { detectNamespaces, isObject, parseArrayOf, parseSingular, parseSingularOf, parseString, retrieveText, trimObject, } from '../../../common/utils.js';
2
- import { retrieveEntry as retrieveAtomEntry, retrieveFeed as retrieveAtomFeed, } from '../../../namespaces/atom/parse/utils.js';
3
- import { retrieveItem as retrieveContentItem } from '../../../namespaces/content/parse/utils.js';
4
- import { retrieveItemOrFeed as retrieveDcItemOrFeed } from '../../../namespaces/dc/parse/utils.js';
5
- import { retrieveItemOrFeed as retrieveDctermsItemOrFeed } from '../../../namespaces/dcterms/parse/utils.js';
6
- import { retrieveItemOrFeed as retrieveGeoRssItemOrFeed } from '../../../namespaces/georss/parse/utils.js';
7
- import { retrieveItemOrFeed as retrieveMediaItemOrFeed } from '../../../namespaces/media/parse/utils.js';
8
- import { retrieveItem as retrieveSlashItem } from '../../../namespaces/slash/parse/utils.js';
9
- import { retrieveFeed as retrieveSyFeed } from '../../../namespaces/sy/parse/utils.js';
10
- import { retrieveItem as retrieveWfwItem } from '../../../namespaces/wfw/parse/utils.js';
11
- export const parseImage = (value) => {
12
- if (!isObject(value)) {
13
- return;
14
- }
15
- const image = {
16
- title: parseSingularOf(value.title, (value) => parseString(retrieveText(value))),
17
- link: parseSingularOf(value.link, (value) => parseString(retrieveText(value))),
18
- url: parseSingularOf(value.url, (value) => parseString(retrieveText(value))),
19
- };
20
- return trimObject(image);
21
- };
22
- export const retrieveImage = (value) => {
23
- // Prepared for https://github.com/macieklamberski/feedsmith/issues/1.
24
- return parseSingularOf(value?.image, parseImage);
25
- };
26
- export const parseTextInput = (value) => {
27
- if (!isObject(value)) {
28
- return;
29
- }
30
- const textInput = {
31
- title: parseSingularOf(value.title, (value) => parseString(retrieveText(value))),
32
- description: parseSingularOf(value.description, (value) => parseString(retrieveText(value))),
33
- name: parseSingularOf(value.name, (value) => parseString(retrieveText(value))),
34
- link: parseSingularOf(value.link, (value) => parseString(retrieveText(value))),
35
- };
36
- return trimObject(textInput);
37
- };
38
- export const retrieveTextInput = (value) => {
39
- // Prepared for https://github.com/macieklamberski/feedsmith/issues/1.
40
- return parseSingularOf(value?.textinput, parseTextInput);
41
- };
42
- export const parseItem = (value) => {
43
- if (!isObject(value)) {
44
- return;
45
- }
46
- const namespaces = detectNamespaces(value);
47
- const item = {
48
- title: parseSingularOf(value.title, (value) => parseString(retrieveText(value))),
49
- link: parseSingularOf(value.link, (value) => parseString(retrieveText(value))),
50
- description: parseSingularOf(value.description, (value) => parseString(retrieveText(value))),
51
- atom: namespaces.has('atom') ? retrieveAtomEntry(value) : undefined,
52
- content: namespaces.has('content') ? retrieveContentItem(value) : undefined,
53
- dc: namespaces.has('dc') ? retrieveDcItemOrFeed(value) : undefined,
54
- dcterms: namespaces.has('dcterms') ? retrieveDctermsItemOrFeed(value) : undefined,
55
- slash: namespaces.has('slash') ? retrieveSlashItem(value) : undefined,
56
- media: namespaces.has('media') ? retrieveMediaItemOrFeed(value) : undefined,
57
- georss: namespaces.has('georss') ? retrieveGeoRssItemOrFeed(value) : undefined,
58
- wfw: namespaces.has('wfw') ? retrieveWfwItem(value) : undefined,
59
- };
60
- return trimObject(item);
61
- };
62
- export const retrieveItems = (value) => {
63
- // Prepared for https://github.com/macieklamberski/feedsmith/issues/1.
64
- return parseArrayOf(value?.item, parseItem);
65
- };
66
- export const parseFeed = (value) => {
67
- if (!isObject(value)) {
68
- return;
69
- }
70
- const channel = parseSingular(value.channel);
71
- const namespaces = detectNamespaces(channel);
72
- const feed = {
73
- title: parseSingularOf(channel?.title, (value) => parseString(retrieveText(value))),
74
- link: parseSingularOf(channel?.link, (value) => parseString(retrieveText(value))),
75
- description: parseSingularOf(channel?.description, (value) => parseString(retrieveText(value))),
76
- image: retrieveImage(value),
77
- items: retrieveItems(value),
78
- textInput: retrieveTextInput(value),
79
- atom: namespaces.has('atom') ? retrieveAtomFeed(channel) : undefined,
80
- dc: namespaces.has('dc') ? retrieveDcItemOrFeed(channel) : undefined,
81
- dcterms: namespaces.has('dcterms') ? retrieveDctermsItemOrFeed(channel) : undefined,
82
- sy: namespaces.has('sy') ? retrieveSyFeed(channel) : undefined,
83
- media: namespaces.has('media') ? retrieveMediaItemOrFeed(channel) : undefined,
84
- georss: namespaces.has('georss') ? retrieveGeoRssItemOrFeed(channel) : undefined,
85
- };
86
- return trimObject(feed);
87
- };
88
- export const retrieveFeed = (value) => {
89
- return parseSingularOf(value?.rdf, parseFeed);
90
- };
@@ -1,111 +0,0 @@
1
- import type { DateLike } from '../../../common/types.js';
2
- import type { Entry as AtomEntry, Feed as AtomFeed } from '../../../namespaces/atom/common/types.js';
3
- import type { Item as ContentItem } from '../../../namespaces/content/common/types.js';
4
- import type { ItemOrFeed as DcItemOrFeed } from '../../../namespaces/dc/common/types.js';
5
- import type { ItemOrFeed as DctermsItemOrFeed } from '../../../namespaces/dcterms/common/types.js';
6
- import type { ItemOrFeed as GeoRssItemOrFeed } from '../../../namespaces/georss/common/types.js';
7
- import type { Feed as ItunesFeed, Item as ItunesItem } from '../../../namespaces/itunes/common/types.js';
8
- import type { ItemOrFeed as MediaItemOrFeed } from '../../../namespaces/media/common/types.js';
9
- import type { Feed as PodcastFeed, Item as PodcastItem } from '../../../namespaces/podcast/common/types.js';
10
- import type { Item as SlashItem } from '../../../namespaces/slash/common/types.js';
11
- import type { Feed as SyFeed } from '../../../namespaces/sy/common/types.js';
12
- import type { Item as ThrItem } from '../../../namespaces/thr/common/types.js';
13
- import type { Item as WfwItem } from '../../../namespaces/wfw/common/types.js';
14
- export type Person = string;
15
- export type Category = {
16
- name: string;
17
- domain?: string;
18
- };
19
- export type Cloud = {
20
- domain: string;
21
- port: number;
22
- path: string;
23
- registerProcedure: string;
24
- protocol: string;
25
- };
26
- export type Image = {
27
- url: string;
28
- title: string;
29
- link: string;
30
- description?: string;
31
- height?: number;
32
- width?: number;
33
- };
34
- export type TextInput = {
35
- title: string;
36
- description: string;
37
- name: string;
38
- link: string;
39
- };
40
- export type Enclosure = {
41
- url: string;
42
- length: number;
43
- type: string;
44
- };
45
- export type SkipHours = Array<number>;
46
- export type SkipDays = Array<string>;
47
- export type Guid = {
48
- value: string;
49
- isPermaLink?: boolean;
50
- };
51
- export type Source = {
52
- title: string;
53
- url?: string;
54
- };
55
- export type Item<TDate extends DateLike> = {
56
- title?: string;
57
- link?: string;
58
- description?: string;
59
- authors?: Array<Person>;
60
- categories?: Array<Category>;
61
- comments?: string;
62
- enclosures?: Array<Enclosure>;
63
- guid?: Guid;
64
- pubDate?: TDate;
65
- source?: Source;
66
- content?: ContentItem;
67
- atom?: AtomEntry<TDate>;
68
- dc?: DcItemOrFeed<TDate>;
69
- dcterms?: DctermsItemOrFeed<TDate>;
70
- slash?: SlashItem;
71
- itunes?: ItunesItem;
72
- podcast?: PodcastItem;
73
- media?: MediaItemOrFeed;
74
- georss?: GeoRssItemOrFeed;
75
- thr?: ThrItem;
76
- wfw?: WfwItem;
77
- } & ({
78
- title: string;
79
- } | {
80
- description: string;
81
- });
82
- export type Feed<TDate extends DateLike> = {
83
- title: string;
84
- link?: string;
85
- description: string;
86
- language?: string;
87
- copyright?: string;
88
- managingEditor?: Person;
89
- webMaster?: Person;
90
- pubDate?: TDate;
91
- lastBuildDate?: TDate;
92
- categories?: Array<Category>;
93
- generator?: string;
94
- docs?: string;
95
- cloud?: Cloud;
96
- ttl?: number;
97
- image?: Image;
98
- rating?: string;
99
- textInput?: TextInput;
100
- skipHours?: Array<number>;
101
- skipDays?: Array<string>;
102
- items?: Array<Item<TDate>>;
103
- atom?: AtomFeed<TDate>;
104
- dc?: DcItemOrFeed<TDate>;
105
- dcterms?: DctermsItemOrFeed<TDate>;
106
- sy?: SyFeed<TDate>;
107
- itunes?: ItunesFeed;
108
- podcast?: PodcastFeed<TDate>;
109
- media?: MediaItemOrFeed;
110
- georss?: GeoRssItemOrFeed;
111
- };
@@ -1,2 +0,0 @@
1
- export {};
2
- // #endregion reference
@@ -1 +0,0 @@
1
- export declare const detect: (value: unknown) => value is string;
@@ -1,13 +0,0 @@
1
- import { isNonEmptyString } from '../../../common/utils.js';
2
- export const detect = (value) => {
3
- if (!isNonEmptyString(value)) {
4
- return false;
5
- }
6
- const hasRssElement = /(?:^|\s|>)\s*<(?:\w+:)?rss[\s>]/im.test(value);
7
- if (!hasRssElement) {
8
- return false;
9
- }
10
- const hasVersionAttribute = /version\s*=\s*["'][^"']*["']/i.test(value);
11
- const hasRssElements = /(<(channel|item|title|link|description|pubDate|guid)[\s>])/i.test(value);
12
- return hasVersionAttribute || hasRssElements;
13
- };
@@ -1,2 +0,0 @@
1
- import { XMLBuilder } from 'fast-xml-parser';
2
- export declare const builder: XMLBuilder;
@@ -1,5 +0,0 @@
1
- import { XMLBuilder } from 'fast-xml-parser';
2
- import { builderConfig } from '../../../common/config.js';
3
- export const builder = new XMLBuilder({
4
- ...builderConfig,
5
- });
@@ -1,3 +0,0 @@
1
- import type { DateLike, DeepPartial, XmlGenerateFunction } from '../../../common/types.js';
2
- import type { Feed } from '../common/types.js';
3
- export declare const generate: XmlGenerateFunction<Feed<Date>, DeepPartial<Feed<DateLike>>>;
@@ -1,10 +0,0 @@
1
- import { generateXml } from '../../../common/utils.js';
2
- import { builder } from './config.js';
3
- import { generateFeed } from './utils.js';
4
- export const generate = (value, options) => {
5
- const generated = generateFeed(value);
6
- if (!generated) {
7
- throw new Error('Invalid input RSS');
8
- }
9
- return generateXml(builder, generated, options);
10
- };
@@ -1,14 +0,0 @@
1
- import type { DateLike, GenerateFunction } from '../../../common/types.js';
2
- import type { Category, Cloud, Enclosure, Feed, Guid, Image, Item, Person, SkipDays, SkipHours, Source, TextInput } from '../common/types.js';
3
- export declare const generatePerson: GenerateFunction<Person>;
4
- export declare const generateCategory: GenerateFunction<Category>;
5
- export declare const generateCloud: GenerateFunction<Cloud>;
6
- export declare const generateImage: GenerateFunction<Image>;
7
- export declare const generateTextInput: GenerateFunction<TextInput>;
8
- export declare const generateEnclosure: GenerateFunction<Enclosure>;
9
- export declare const generateSkipHours: GenerateFunction<SkipHours>;
10
- export declare const generateSkipDays: GenerateFunction<SkipDays>;
11
- export declare const generateGuid: GenerateFunction<Guid>;
12
- export declare const generateSource: GenerateFunction<Source>;
13
- export declare const generateItem: GenerateFunction<Item<DateLike>>;
14
- export declare const generateFeed: GenerateFunction<Feed<DateLike>>;