feedsmith 2.0.0 → 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 (159) hide show
  1. package/README.md +7 -4
  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 +14 -10
  6. package/dist/common/config.d.ts +0 -23
  7. package/dist/common/config.js +0 -43
  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 -111
  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 -181
  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 -163
  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/sy/common/types.d.ts +0 -6
  123. package/dist/namespaces/sy/common/types.js +0 -2
  124. package/dist/namespaces/sy/generate/utils.d.ts +0 -3
  125. package/dist/namespaces/sy/generate/utils.js +0 -12
  126. package/dist/namespaces/sy/parse/utils.d.ts +0 -3
  127. package/dist/namespaces/sy/parse/utils.js +0 -12
  128. package/dist/namespaces/thr/common/types.d.ts +0 -15
  129. package/dist/namespaces/thr/common/types.js +0 -2
  130. package/dist/namespaces/thr/generate/utils.d.ts +0 -5
  131. package/dist/namespaces/thr/generate/utils.js +0 -33
  132. package/dist/namespaces/thr/parse/utils.d.ts +0 -5
  133. package/dist/namespaces/thr/parse/utils.js +0 -33
  134. package/dist/namespaces/wfw/common/types.d.ts +0 -4
  135. package/dist/namespaces/wfw/common/types.js +0 -2
  136. package/dist/namespaces/wfw/generate/utils.d.ts +0 -3
  137. package/dist/namespaces/wfw/generate/utils.js +0 -11
  138. package/dist/namespaces/wfw/parse/utils.d.ts +0 -3
  139. package/dist/namespaces/wfw/parse/utils.js +0 -11
  140. package/dist/namespaces/yt/common/types.d.ts +0 -8
  141. package/dist/namespaces/yt/common/types.js +0 -2
  142. package/dist/namespaces/yt/generate/utils.d.ts +0 -4
  143. package/dist/namespaces/yt/generate/utils.js +0 -21
  144. package/dist/namespaces/yt/parse/utils.d.ts +0 -4
  145. package/dist/namespaces/yt/parse/utils.js +0 -21
  146. package/dist/opml/common/types.d.ts +0 -39
  147. package/dist/opml/common/types.js +0 -2
  148. package/dist/opml/generate/config.d.ts +0 -2
  149. package/dist/opml/generate/config.js +0 -5
  150. package/dist/opml/generate/index.d.ts +0 -3
  151. package/dist/opml/generate/index.js +0 -10
  152. package/dist/opml/generate/utils.d.ts +0 -6
  153. package/dist/opml/generate/utils.js +0 -66
  154. package/dist/opml/parse/config.d.ts +0 -3
  155. package/dist/opml/parse/config.js +0 -22
  156. package/dist/opml/parse/index.d.ts +0 -3
  157. package/dist/opml/parse/index.js +0 -10
  158. package/dist/opml/parse/utils.d.ts +0 -6
  159. package/dist/opml/parse/utils.js +0 -63
package/package.json CHANGED
@@ -31,37 +31,41 @@
31
31
  "type": "module",
32
32
  "exports": {
33
33
  ".": {
34
+ "types": "./dist/index.d.ts",
34
35
  "import": "./dist/index.js",
35
- "types": "./dist/index.d.ts"
36
+ "require": "./dist/index.cjs"
36
37
  }
37
38
  },
38
39
  "files": [
39
- "dist"
40
+ "dist/*.js",
41
+ "dist/*.cjs",
42
+ "dist/*.d.ts"
40
43
  ],
41
44
  "scripts": {
42
45
  "prepare": "lefthook install",
43
46
  "lint:tsc": "tsc --pretty --noEmit",
44
47
  "lint:biome": "bunx @biomejs/biome check --write --no-errors-on-unmatched --files-ignore-unknown=true",
45
- "build": "rm -rf dist && tsc",
48
+ "build": "tsdown --format cjs,esm",
46
49
  "docs:dev": "vitepress dev docs",
47
50
  "docs:build": "vitepress build docs",
48
51
  "docs:preview": "vitepress preview docs"
49
52
  },
50
53
  "dependencies": {
51
- "entities": "^6.0.1",
54
+ "entities": "^7.0.0",
52
55
  "fast-xml-parser": "^5.2.5"
53
56
  },
54
57
  "devDependencies": {
55
- "@biomejs/biome": "^2.2.2",
58
+ "@biomejs/biome": "^2.2.4",
56
59
  "@commitlint/cli": "^19.8.1",
57
60
  "@commitlint/config-conventional": "^19.8.1",
58
- "@types/bun": "^1.2.21",
61
+ "@types/bun": "^1.2.22",
59
62
  "conventional-changelog-conventionalcommits": "^9.1.0",
60
- "lefthook": "^1.12.3",
61
- "semantic-release": "^24.2.7",
63
+ "lefthook": "^1.13.0",
64
+ "semantic-release": "^24.2.8",
65
+ "tsdown": "^0.15.1",
62
66
  "typescript": "^5.9.2",
63
67
  "vitepress": "^1.6.4",
64
- "vitepress-plugin-llms": "^1.7.3"
68
+ "vitepress-plugin-llms": "^1.7.5"
65
69
  },
66
- "version": "2.0.0"
70
+ "version": "2.1.0"
67
71
  }
@@ -1,23 +0,0 @@
1
- import type { X2jOptions, XmlBuilderOptions } from 'fast-xml-parser';
2
- export declare const parserConfig: X2jOptions;
3
- export declare const builderConfig: XmlBuilderOptions;
4
- export declare const locales: {
5
- unrecognized: string;
6
- invalid: string;
7
- };
8
- export declare const namespaceUrls: {
9
- atom: string;
10
- content: string;
11
- dc: string;
12
- dcterms: string;
13
- georss: string;
14
- itunes: string;
15
- media: string;
16
- podcast: string;
17
- rdf: string;
18
- slash: string;
19
- sy: string;
20
- thr: string;
21
- wfw: string;
22
- yt: string;
23
- };
@@ -1,43 +0,0 @@
1
- export const parserConfig = {
2
- trimValues: false,
3
- processEntities: false,
4
- htmlEntities: false,
5
- parseTagValue: false,
6
- parseAttributeValue: false,
7
- alwaysCreateTextNode: false,
8
- ignoreAttributes: false,
9
- ignorePiTags: true,
10
- ignoreDeclaration: true,
11
- attributeNamePrefix: '@',
12
- transformTagName: (name) => name.toLowerCase(),
13
- transformAttributeName: (name) => name.toLowerCase(),
14
- };
15
- export const builderConfig = {
16
- processEntities: true,
17
- ignoreAttributes: false,
18
- suppressEmptyNode: true,
19
- suppressBooleanAttributes: false,
20
- attributeNamePrefix: '@',
21
- format: true,
22
- cdataPropName: '#cdata',
23
- };
24
- export const locales = {
25
- unrecognized: 'Unrecognized feed format',
26
- invalid: 'Invalid feed format',
27
- };
28
- export const namespaceUrls = {
29
- atom: 'http://www.w3.org/2005/Atom',
30
- content: 'http://purl.org/rss/1.0/modules/content/',
31
- dc: 'http://purl.org/dc/elements/1.1/',
32
- dcterms: 'http://purl.org/dc/terms/',
33
- georss: 'http://www.georss.org/georss/',
34
- itunes: 'http://www.itunes.com/dtds/podcast-1.0.dtd',
35
- media: 'http://search.yahoo.com/mrss/',
36
- podcast: 'https://podcastindex.org/namespace/1.0',
37
- rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
38
- slash: 'http://purl.org/rss/1.0/modules/slash/',
39
- sy: 'http://purl.org/rss/1.0/modules/syndication/',
40
- thr: 'http://purl.org/syndication/thread/1.0',
41
- wfw: 'http://wellformedweb.org/CommentAPI/',
42
- yt: 'http://www.youtube.com/xml/schemas/2015',
43
- };
@@ -1,19 +0,0 @@
1
- import type { Feed as AtomFeed } from '../feeds/atom/common/types.js';
2
- import type { Feed as JsonFeed } from '../feeds/json/common/types.js';
3
- import type { Feed as RdfFeed } from '../feeds/rdf/common/types.js';
4
- import type { Feed as RssFeed } from '../feeds/rss/common/types.js';
5
- import type { DeepPartial } from './types.js';
6
- export type Feed = {
7
- format: 'rss';
8
- feed: DeepPartial<RssFeed<string>>;
9
- } | {
10
- format: 'atom';
11
- feed: DeepPartial<AtomFeed<string>>;
12
- } | {
13
- format: 'rdf';
14
- feed: DeepPartial<RdfFeed<string>>;
15
- } | {
16
- format: 'json';
17
- feed: DeepPartial<JsonFeed<string>>;
18
- };
19
- export declare const parse: (value: unknown) => Feed;
@@ -1,24 +0,0 @@
1
- import { detect as detectAtomFeed } from '../feeds/atom/detect/index.js';
2
- import { parse as parseAtomFeed } from '../feeds/atom/parse/index.js';
3
- import { detect as detectJsonFeed } from '../feeds/json/detect/index.js';
4
- import { parse as parseJsonFeed } from '../feeds/json/parse/index.js';
5
- import { detect as detectRdfFeed } from '../feeds/rdf/detect/index.js';
6
- import { parse as parseRdfFeed } from '../feeds/rdf/parse/index.js';
7
- import { detect as detectRssFeed } from '../feeds/rss/detect/index.js';
8
- import { parse as parseRssFeed } from '../feeds/rss/parse/index.js';
9
- import { locales } from './config.js';
10
- export const parse = (value) => {
11
- if (detectRssFeed(value)) {
12
- return { format: 'rss', feed: parseRssFeed(value) };
13
- }
14
- if (detectAtomFeed(value)) {
15
- return { format: 'atom', feed: parseAtomFeed(value) };
16
- }
17
- if (detectRdfFeed(value)) {
18
- return { format: 'rdf', feed: parseRdfFeed(value) };
19
- }
20
- if (detectJsonFeed(value)) {
21
- return { format: 'json', feed: parseJsonFeed(value) };
22
- }
23
- throw new Error(locales.unrecognized);
24
- };
@@ -1,41 +0,0 @@
1
- export type Unreliable = any;
2
- export type DateLike = Date | string;
3
- export type AnyOf<T> = Partial<{
4
- [P in keyof T]-?: NonNullable<T[P]>;
5
- }> & {
6
- [P in keyof T]-?: Pick<{
7
- [Q in keyof T]-?: NonNullable<T[Q]>;
8
- }, P>;
9
- }[keyof T];
10
- export type DeepPartial<T> = T extends Array<infer U> ? Array<DeepPartial<U>> : T extends (...args: Array<unknown>) => unknown ? T : T extends object ? T extends null ? T : {
11
- [P in keyof T]?: DeepPartial<T[P]>;
12
- } : T;
13
- export type ParseExactFunction<R> = (value: Unreliable) => R | undefined;
14
- export type ParsePartialFunction<R> = (value: Unreliable) => DeepPartial<R> | undefined;
15
- export type GenerateFunction<V> = (value: V | undefined) => Unreliable | undefined;
16
- export type XmlStylesheet = {
17
- type: string;
18
- href: string;
19
- title?: string;
20
- media?: string;
21
- charset?: string;
22
- alternate?: boolean;
23
- };
24
- export type XmlGenerateFunction<TStrict, TLenient> = {
25
- (value: TStrict, options?: {
26
- lenient?: false;
27
- stylesheets?: Array<XmlStylesheet>;
28
- }): string;
29
- (value: TLenient, options: {
30
- lenient: true;
31
- stylesheets?: Array<XmlStylesheet>;
32
- }): string;
33
- };
34
- export type JsonGenerateFunction<TStrict, TLenient> = {
35
- (value: TStrict, options?: {
36
- lenient?: false;
37
- }): unknown;
38
- (value: TLenient, options: {
39
- lenient: true;
40
- }): unknown;
41
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,37 +0,0 @@
1
- import type { XMLBuilder } from 'fast-xml-parser';
2
- import type { AnyOf, DateLike, GenerateFunction, ParseExactFunction, Unreliable, XmlStylesheet } from './types.js';
3
- export declare const isPresent: <T>(value: T) => value is NonNullable<T>;
4
- export declare const isObject: (value: Unreliable) => value is Record<string, Unreliable>;
5
- export declare const isNonEmptyString: (value: Unreliable) => value is string;
6
- export declare const isNonEmptyStringOrNumber: (value: Unreliable) => value is string | number;
7
- export declare const retrieveText: (value: Unreliable) => Unreliable;
8
- export declare const trimObject: <T extends Record<string, unknown>>(object: T) => AnyOf<T> | undefined;
9
- export declare const trimArray: <T, R = T>(value: Array<T> | undefined, parse?: ParseExactFunction<R>) => Array<R> | undefined;
10
- export declare const stripCdata: (text: Unreliable) => any;
11
- export declare const hasEntities: (text: string) => boolean;
12
- export declare const parseString: ParseExactFunction<string>;
13
- export declare const parseNumber: ParseExactFunction<number>;
14
- export declare const parseBoolean: ParseExactFunction<boolean>;
15
- export declare const parseYesNoBoolean: ParseExactFunction<boolean>;
16
- export declare const parseDate: ParseExactFunction<string>;
17
- export declare const parseArray: ParseExactFunction<Array<Unreliable>>;
18
- export declare const parseArrayOf: <R>(value: Unreliable, parse: ParseExactFunction<R>) => Array<R> | undefined;
19
- export declare const parseSingular: <T>(value: T | Array<T>) => T;
20
- export declare const parseSingularOf: <R>(value: Unreliable, parse: ParseExactFunction<R>) => R | undefined;
21
- export declare const parseCsvOf: <T>(value: Unreliable, parse: ParseExactFunction<T>) => Array<T> | undefined;
22
- export declare const generateCsvOf: <T>(value: Array<T> | undefined, generate?: GenerateFunction<T>) => string | undefined;
23
- export declare const generateXmlStylesheet: (stylesheet: XmlStylesheet) => string | undefined;
24
- export declare const generateXml: (builder: XMLBuilder, value: string, options?: {
25
- stylesheets?: Array<XmlStylesheet>;
26
- }) => string;
27
- export declare const generateRfc822Date: GenerateFunction<DateLike>;
28
- export declare const generateRfc3339Date: GenerateFunction<DateLike>;
29
- export declare const generateBoolean: GenerateFunction<boolean>;
30
- export declare const generateYesNoBoolean: GenerateFunction<boolean>;
31
- export declare const detectNamespaces: (value: unknown, recursive?: boolean) => Set<string>;
32
- export declare const generateCdataString: GenerateFunction<string>;
33
- export declare const generatePlainString: GenerateFunction<string>;
34
- export declare const generateNumber: GenerateFunction<number>;
35
- export declare const generateNamespaceAttrs: (value: Unreliable, namespaceUrls: Record<string, string>) => Record<string, string> | undefined;
36
- export declare const invertObject: (object: Record<string, string>) => Record<string, string>;
37
- export declare const createNamespaceNormalizator: (namespaceUrls: Record<string, string>, primaryNamespace?: string) => (object: Unreliable) => Unreliable;