feedsmith 2.9.2 → 3.0.0-beta.2

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 (156) hide show
  1. package/README.md +3 -9
  2. package/dist/common/config.cjs +2 -1
  3. package/dist/common/config.js +2 -1
  4. package/dist/common/errors.cjs +30 -0
  5. package/dist/common/errors.d.cts +15 -0
  6. package/dist/common/errors.d.ts +15 -0
  7. package/dist/common/errors.js +27 -0
  8. package/dist/common/parse.cjs +2 -1
  9. package/dist/common/parse.d.cts +10 -11
  10. package/dist/common/parse.d.ts +10 -11
  11. package/dist/common/parse.js +2 -1
  12. package/dist/common/types.d.cts +24 -12
  13. package/dist/common/types.d.ts +24 -12
  14. package/dist/common/utils.cjs +6 -14
  15. package/dist/common/utils.js +7 -13
  16. package/dist/feeds/atom/common/types.d.cts +65 -52
  17. package/dist/feeds/atom/common/types.d.ts +65 -52
  18. package/dist/feeds/atom/generate/index.cjs +2 -1
  19. package/dist/feeds/atom/generate/index.d.cts +2 -2
  20. package/dist/feeds/atom/generate/index.d.ts +2 -2
  21. package/dist/feeds/atom/generate/index.js +2 -1
  22. package/dist/feeds/atom/generate/utils.cjs +23 -6
  23. package/dist/feeds/atom/generate/utils.js +20 -3
  24. package/dist/feeds/atom/parse/index.cjs +10 -3
  25. package/dist/feeds/atom/parse/index.d.cts +2 -2
  26. package/dist/feeds/atom/parse/index.d.ts +2 -2
  27. package/dist/feeds/atom/parse/index.js +10 -3
  28. package/dist/feeds/atom/parse/utils.cjs +61 -31
  29. package/dist/feeds/atom/parse/utils.js +59 -29
  30. package/dist/feeds/json/common/types.d.cts +19 -19
  31. package/dist/feeds/json/common/types.d.ts +19 -19
  32. package/dist/feeds/json/generate/index.cjs +5 -1
  33. package/dist/feeds/json/generate/index.d.cts +2 -2
  34. package/dist/feeds/json/generate/index.d.ts +2 -2
  35. package/dist/feeds/json/generate/index.js +5 -1
  36. package/dist/feeds/json/generate/utils.cjs +7 -2
  37. package/dist/feeds/json/generate/utils.js +8 -3
  38. package/dist/feeds/json/parse/index.cjs +3 -2
  39. package/dist/feeds/json/parse/index.d.cts +2 -2
  40. package/dist/feeds/json/parse/index.d.ts +2 -2
  41. package/dist/feeds/json/parse/index.js +3 -2
  42. package/dist/feeds/json/parse/utils.cjs +4 -4
  43. package/dist/feeds/json/parse/utils.js +4 -4
  44. package/dist/feeds/rdf/common/types.d.cts +31 -28
  45. package/dist/feeds/rdf/common/types.d.ts +31 -28
  46. package/dist/feeds/rdf/parse/index.cjs +10 -3
  47. package/dist/feeds/rdf/parse/index.d.cts +2 -2
  48. package/dist/feeds/rdf/parse/index.d.ts +2 -2
  49. package/dist/feeds/rdf/parse/index.js +10 -3
  50. package/dist/feeds/rdf/parse/utils.cjs +23 -20
  51. package/dist/feeds/rdf/parse/utils.js +15 -12
  52. package/dist/feeds/rss/common/types.d.cts +76 -74
  53. package/dist/feeds/rss/common/types.d.ts +76 -74
  54. package/dist/feeds/rss/generate/index.cjs +2 -1
  55. package/dist/feeds/rss/generate/index.d.cts +2 -2
  56. package/dist/feeds/rss/generate/index.d.ts +2 -2
  57. package/dist/feeds/rss/generate/index.js +2 -1
  58. package/dist/feeds/rss/generate/utils.cjs +36 -36
  59. package/dist/feeds/rss/generate/utils.js +10 -10
  60. package/dist/feeds/rss/parse/index.cjs +10 -3
  61. package/dist/feeds/rss/parse/index.d.cts +2 -2
  62. package/dist/feeds/rss/parse/index.d.ts +2 -2
  63. package/dist/feeds/rss/parse/index.js +10 -3
  64. package/dist/feeds/rss/parse/utils.cjs +138 -38
  65. package/dist/feeds/rss/parse/utils.js +119 -19
  66. package/dist/index.cjs +5 -0
  67. package/dist/index.d.cts +37 -16
  68. package/dist/index.d.ts +37 -16
  69. package/dist/index.js +2 -1
  70. package/dist/namespaces/app/common/types.d.cts +1 -3
  71. package/dist/namespaces/app/common/types.d.ts +1 -3
  72. package/dist/namespaces/app/parse/utils.cjs +2 -2
  73. package/dist/namespaces/app/parse/utils.js +2 -2
  74. package/dist/namespaces/atom/common/types.d.cts +3 -3
  75. package/dist/namespaces/atom/common/types.d.ts +3 -3
  76. package/dist/namespaces/atom/parse/utils.cjs +4 -2
  77. package/dist/namespaces/atom/parse/utils.js +4 -2
  78. package/dist/namespaces/dc/common/types.d.cts +4 -19
  79. package/dist/namespaces/dc/common/types.d.ts +4 -19
  80. package/dist/namespaces/dc/generate/utils.cjs +15 -15
  81. package/dist/namespaces/dc/generate/utils.js +16 -16
  82. package/dist/namespaces/dc/parse/utils.cjs +4 -17
  83. package/dist/namespaces/dc/parse/utils.js +5 -18
  84. package/dist/namespaces/dcterms/common/types.d.cts +23 -59
  85. package/dist/namespaces/dcterms/common/types.d.ts +23 -59
  86. package/dist/namespaces/dcterms/generate/utils.cjs +55 -55
  87. package/dist/namespaces/dcterms/generate/utils.js +56 -56
  88. package/dist/namespaces/dcterms/parse/utils.cjs +23 -57
  89. package/dist/namespaces/dcterms/parse/utils.js +24 -58
  90. package/dist/namespaces/georss/common/types.d.cts +21 -19
  91. package/dist/namespaces/georss/common/types.d.ts +21 -19
  92. package/dist/namespaces/georss/generate/utils.cjs +2 -2
  93. package/dist/namespaces/georss/generate/utils.js +2 -2
  94. package/dist/namespaces/googleplay/common/types.d.cts +9 -7
  95. package/dist/namespaces/googleplay/common/types.d.ts +9 -7
  96. package/dist/namespaces/itunes/common/types.d.cts +9 -5
  97. package/dist/namespaces/itunes/common/types.d.ts +9 -5
  98. package/dist/namespaces/media/common/types.d.cts +85 -84
  99. package/dist/namespaces/media/common/types.d.ts +85 -84
  100. package/dist/namespaces/media/generate/utils.cjs +1 -1
  101. package/dist/namespaces/media/generate/utils.js +2 -2
  102. package/dist/namespaces/media/parse/utils.cjs +1 -2
  103. package/dist/namespaces/media/parse/utils.js +1 -2
  104. package/dist/namespaces/opensearch/common/types.d.cts +7 -5
  105. package/dist/namespaces/opensearch/common/types.d.ts +7 -5
  106. package/dist/namespaces/podcast/common/types.d.cts +136 -142
  107. package/dist/namespaces/podcast/common/types.d.ts +136 -142
  108. package/dist/namespaces/podcast/generate/utils.cjs +6 -6
  109. package/dist/namespaces/podcast/generate/utils.js +7 -7
  110. package/dist/namespaces/podcast/parse/utils.cjs +13 -19
  111. package/dist/namespaces/podcast/parse/utils.js +13 -19
  112. package/dist/namespaces/prism/common/types.d.cts +2 -4
  113. package/dist/namespaces/prism/common/types.d.ts +2 -4
  114. package/dist/namespaces/prism/parse/utils.cjs +19 -19
  115. package/dist/namespaces/prism/parse/utils.js +19 -19
  116. package/dist/namespaces/psc/common/types.d.cts +8 -6
  117. package/dist/namespaces/psc/common/types.d.ts +8 -6
  118. package/dist/namespaces/rawvoice/common/types.d.cts +24 -24
  119. package/dist/namespaces/rawvoice/common/types.d.ts +24 -24
  120. package/dist/namespaces/rawvoice/parse/utils.cjs +7 -7
  121. package/dist/namespaces/rawvoice/parse/utils.js +7 -7
  122. package/dist/namespaces/source/common/types.d.cts +20 -18
  123. package/dist/namespaces/source/common/types.d.ts +20 -18
  124. package/dist/namespaces/spotify/common/types.d.cts +22 -20
  125. package/dist/namespaces/spotify/common/types.d.ts +22 -20
  126. package/dist/namespaces/sy/common/types.d.cts +1 -3
  127. package/dist/namespaces/sy/common/types.d.ts +1 -3
  128. package/dist/namespaces/sy/parse/utils.cjs +2 -2
  129. package/dist/namespaces/sy/parse/utils.js +2 -2
  130. package/dist/namespaces/thr/common/types.d.cts +7 -7
  131. package/dist/namespaces/thr/common/types.d.ts +7 -7
  132. package/dist/namespaces/thr/parse/utils.cjs +2 -2
  133. package/dist/namespaces/thr/parse/utils.js +2 -2
  134. package/dist/namespaces/xml/common/types.d.cts +11 -0
  135. package/dist/namespaces/xml/common/types.d.ts +11 -0
  136. package/dist/namespaces/xml/generate/utils.cjs +13 -0
  137. package/dist/namespaces/xml/generate/utils.js +13 -0
  138. package/dist/namespaces/xml/parse/utils.cjs +13 -0
  139. package/dist/namespaces/xml/parse/utils.js +13 -0
  140. package/dist/opml/common/types.d.cts +18 -13
  141. package/dist/opml/common/types.d.ts +18 -13
  142. package/dist/opml/generate/index.cjs +2 -1
  143. package/dist/opml/generate/index.d.cts +3 -3
  144. package/dist/opml/generate/index.d.ts +3 -3
  145. package/dist/opml/generate/index.js +2 -1
  146. package/dist/opml/parse/index.cjs +9 -2
  147. package/dist/opml/parse/index.d.cts +2 -3
  148. package/dist/opml/parse/index.d.ts +2 -3
  149. package/dist/opml/parse/index.js +9 -2
  150. package/dist/opml/parse/utils.cjs +5 -5
  151. package/dist/opml/parse/utils.js +5 -5
  152. package/package.json +2 -19
  153. package/dist/types.cjs +0 -0
  154. package/dist/types.d.cts +0 -7
  155. package/dist/types.d.ts +0 -7
  156. package/dist/types.js +0 -1
@@ -1,31 +1,33 @@
1
+ import { Requirable, Strict } from "../../../common/types.js";
2
+
1
3
  //#region src/namespaces/spotify/common/types.d.ts
2
4
  declare namespace SpotifyNs {
3
5
  type Limit = {
4
6
  recentCount?: number;
5
7
  };
6
- type Partner = {
7
- id: string;
8
- };
9
- type Sandbox = {
10
- enabled: boolean;
11
- };
12
- type FeedAccess = {
13
- partner?: Partner;
14
- sandbox?: Sandbox;
15
- };
16
- type Entitlement = {
17
- name: string;
18
- };
19
- type ItemAccess = {
20
- entitlement?: Entitlement;
21
- };
22
- type Feed = {
8
+ type Partner<TStrict extends boolean = false> = Strict<{
9
+ id: Requirable<string>;
10
+ }, TStrict>;
11
+ type Sandbox<TStrict extends boolean = false> = Strict<{
12
+ enabled: Requirable<boolean>;
13
+ }, TStrict>;
14
+ type FeedAccess<TStrict extends boolean = false> = {
15
+ partner?: Partner<TStrict>;
16
+ sandbox?: Sandbox<TStrict>;
17
+ };
18
+ type Entitlement<TStrict extends boolean = false> = Strict<{
19
+ name: Requirable<string>;
20
+ }, TStrict>;
21
+ type ItemAccess<TStrict extends boolean = false> = {
22
+ entitlement?: Entitlement<TStrict>;
23
+ };
24
+ type Feed<TStrict extends boolean = false> = {
23
25
  limit?: Limit;
24
26
  countryOfOrigin?: string;
25
- access?: FeedAccess;
27
+ access?: FeedAccess<TStrict>;
26
28
  };
27
- type Item = {
28
- access?: ItemAccess;
29
+ type Item<TStrict extends boolean = false> = {
30
+ access?: ItemAccess<TStrict>;
29
31
  };
30
32
  }
31
33
  //#endregion
@@ -1,8 +1,6 @@
1
- import { DateLike } from "../../../common/types.cjs";
2
-
3
1
  //#region src/namespaces/sy/common/types.d.ts
4
2
  declare namespace SyNs {
5
- type Feed<TDate extends DateLike> = {
3
+ type Feed<TDate> = {
6
4
  updatePeriod?: string;
7
5
  updateFrequency?: number;
8
6
  updateBase?: TDate;
@@ -1,8 +1,6 @@
1
- import { DateLike } from "../../../common/types.js";
2
-
3
1
  //#region src/namespaces/sy/common/types.d.ts
4
2
  declare namespace SyNs {
5
- type Feed<TDate extends DateLike> = {
3
+ type Feed<TDate> = {
6
4
  updatePeriod?: string;
7
5
  updateFrequency?: number;
8
6
  updateBase?: TDate;
@@ -1,11 +1,11 @@
1
1
  const require_utils = require("../../../common/utils.cjs");
2
2
  //#region src/namespaces/sy/parse/utils.ts
3
- const retrieveFeed = (value) => {
3
+ const retrieveFeed = (value, options) => {
4
4
  if (!require_utils.isObject(value)) return;
5
5
  return require_utils.trimObject({
6
6
  updatePeriod: require_utils.parseSingularOf(value["sy:updateperiod"], (value) => require_utils.parseString(require_utils.retrieveText(value))),
7
7
  updateFrequency: require_utils.parseSingularOf(value["sy:updatefrequency"], (value) => require_utils.parseNumber(require_utils.retrieveText(value))),
8
- updateBase: require_utils.parseSingularOf(value["sy:updatebase"], (value) => require_utils.parseDate(require_utils.retrieveText(value)))
8
+ updateBase: require_utils.parseSingularOf(value["sy:updatebase"], (value) => require_utils.parseDate(require_utils.retrieveText(value), options?.parseDateFn))
9
9
  });
10
10
  };
11
11
  //#endregion
@@ -1,11 +1,11 @@
1
1
  import { isObject, parseDate, parseNumber, parseSingularOf, parseString, retrieveText, trimObject } from "../../../common/utils.js";
2
2
  //#region src/namespaces/sy/parse/utils.ts
3
- const retrieveFeed = (value) => {
3
+ const retrieveFeed = (value, options) => {
4
4
  if (!isObject(value)) return;
5
5
  return trimObject({
6
6
  updatePeriod: parseSingularOf(value["sy:updateperiod"], (value) => parseString(retrieveText(value))),
7
7
  updateFrequency: parseSingularOf(value["sy:updatefrequency"], (value) => parseNumber(retrieveText(value))),
8
- updateBase: parseSingularOf(value["sy:updatebase"], (value) => parseDate(retrieveText(value)))
8
+ updateBase: parseSingularOf(value["sy:updatebase"], (value) => parseDate(retrieveText(value), options?.parseDateFn))
9
9
  });
10
10
  };
11
11
  //#endregion
@@ -1,20 +1,20 @@
1
- import { DateLike } from "../../../common/types.cjs";
1
+ import { Requirable, Strict } from "../../../common/types.cjs";
2
2
 
3
3
  //#region src/namespaces/thr/common/types.d.ts
4
4
  declare namespace ThrNs {
5
- type InReplyTo = {
6
- ref: string;
5
+ type InReplyTo<TStrict extends boolean = false> = Strict<{
6
+ ref: Requirable<string>;
7
7
  href?: string;
8
8
  type?: string;
9
9
  source?: string;
10
- };
11
- type Link<TDate extends DateLike> = {
10
+ }, TStrict>;
11
+ type Link<TDate> = {
12
12
  count?: number;
13
13
  updated?: TDate;
14
14
  };
15
- type Item = {
15
+ type Item<TStrict extends boolean = false> = {
16
16
  total?: number;
17
- inReplyTos?: Array<InReplyTo>;
17
+ inReplyTos?: Array<InReplyTo<TStrict>>;
18
18
  };
19
19
  }
20
20
  //#endregion
@@ -1,20 +1,20 @@
1
- import { DateLike } from "../../../common/types.js";
1
+ import { Requirable, Strict } from "../../../common/types.js";
2
2
 
3
3
  //#region src/namespaces/thr/common/types.d.ts
4
4
  declare namespace ThrNs {
5
- type InReplyTo = {
6
- ref: string;
5
+ type InReplyTo<TStrict extends boolean = false> = Strict<{
6
+ ref: Requirable<string>;
7
7
  href?: string;
8
8
  type?: string;
9
9
  source?: string;
10
- };
11
- type Link<TDate extends DateLike> = {
10
+ }, TStrict>;
11
+ type Link<TDate> = {
12
12
  count?: number;
13
13
  updated?: TDate;
14
14
  };
15
- type Item = {
15
+ type Item<TStrict extends boolean = false> = {
16
16
  total?: number;
17
- inReplyTos?: Array<InReplyTo>;
17
+ inReplyTos?: Array<InReplyTo<TStrict>>;
18
18
  };
19
19
  }
20
20
  //#endregion
@@ -9,11 +9,11 @@ const parseInReplyTo = (value) => {
9
9
  source: require_utils.parseString(value["@source"])
10
10
  });
11
11
  };
12
- const retrieveLink = (value) => {
12
+ const retrieveLink = (value, options) => {
13
13
  if (!require_utils.isObject(value)) return;
14
14
  return require_utils.trimObject({
15
15
  count: require_utils.parseNumber(value["@thr:count"]),
16
- updated: require_utils.parseDate(value["@thr:updated"])
16
+ updated: require_utils.parseDate(value["@thr:updated"], options?.parseDateFn)
17
17
  });
18
18
  };
19
19
  const retrieveItem = (value) => {
@@ -9,11 +9,11 @@ const parseInReplyTo = (value) => {
9
9
  source: parseString(value["@source"])
10
10
  });
11
11
  };
12
- const retrieveLink = (value) => {
12
+ const retrieveLink = (value, options) => {
13
13
  if (!isObject(value)) return;
14
14
  return trimObject({
15
15
  count: parseNumber(value["@thr:count"]),
16
- updated: parseDate(value["@thr:updated"])
16
+ updated: parseDate(value["@thr:updated"], options?.parseDateFn)
17
17
  });
18
18
  };
19
19
  const retrieveItem = (value) => {
@@ -0,0 +1,11 @@
1
+ //#region src/namespaces/xml/common/types.d.ts
2
+ declare namespace XmlNs {
3
+ type ItemOrFeed = {
4
+ lang?: string;
5
+ base?: string;
6
+ space?: string;
7
+ id?: string;
8
+ };
9
+ }
10
+ //#endregion
11
+ export { XmlNs };
@@ -0,0 +1,11 @@
1
+ //#region src/namespaces/xml/common/types.d.ts
2
+ declare namespace XmlNs {
3
+ type ItemOrFeed = {
4
+ lang?: string;
5
+ base?: string;
6
+ space?: string;
7
+ id?: string;
8
+ };
9
+ }
10
+ //#endregion
11
+ export { XmlNs };
@@ -0,0 +1,13 @@
1
+ const require_utils = require("../../../common/utils.cjs");
2
+ //#region src/namespaces/xml/generate/utils.ts
3
+ const generateItemOrFeed = (itemOrFeed) => {
4
+ if (!require_utils.isObject(itemOrFeed)) return;
5
+ return require_utils.trimObject({
6
+ "@xml:lang": require_utils.generatePlainString(itemOrFeed.lang),
7
+ "@xml:base": require_utils.generatePlainString(itemOrFeed.base),
8
+ "@xml:space": require_utils.generatePlainString(itemOrFeed.space),
9
+ "@xml:id": require_utils.generatePlainString(itemOrFeed.id)
10
+ });
11
+ };
12
+ //#endregion
13
+ exports.generateItemOrFeed = generateItemOrFeed;
@@ -0,0 +1,13 @@
1
+ import { generatePlainString, isObject, trimObject } from "../../../common/utils.js";
2
+ //#region src/namespaces/xml/generate/utils.ts
3
+ const generateItemOrFeed = (itemOrFeed) => {
4
+ if (!isObject(itemOrFeed)) return;
5
+ return trimObject({
6
+ "@xml:lang": generatePlainString(itemOrFeed.lang),
7
+ "@xml:base": generatePlainString(itemOrFeed.base),
8
+ "@xml:space": generatePlainString(itemOrFeed.space),
9
+ "@xml:id": generatePlainString(itemOrFeed.id)
10
+ });
11
+ };
12
+ //#endregion
13
+ export { generateItemOrFeed };
@@ -0,0 +1,13 @@
1
+ const require_utils = require("../../../common/utils.cjs");
2
+ //#region src/namespaces/xml/parse/utils.ts
3
+ const retrieveItemOrFeed = (value) => {
4
+ if (!require_utils.isObject(value)) return;
5
+ return require_utils.trimObject({
6
+ lang: require_utils.parseString(value["@xml:lang"]),
7
+ base: require_utils.parseString(value["@xml:base"]),
8
+ space: require_utils.parseString(value["@xml:space"]),
9
+ id: require_utils.parseString(value["@xml:id"])
10
+ });
11
+ };
12
+ //#endregion
13
+ exports.retrieveItemOrFeed = retrieveItemOrFeed;
@@ -0,0 +1,13 @@
1
+ import { isObject, parseString, trimObject } from "../../../common/utils.js";
2
+ //#region src/namespaces/xml/parse/utils.ts
3
+ const retrieveItemOrFeed = (value) => {
4
+ if (!isObject(value)) return;
5
+ return trimObject({
6
+ lang: parseString(value["@xml:lang"]),
7
+ base: parseString(value["@xml:base"]),
8
+ space: parseString(value["@xml:space"]),
9
+ id: parseString(value["@xml:id"])
10
+ });
11
+ };
12
+ //#endregion
13
+ export { retrieveItemOrFeed };
@@ -1,12 +1,15 @@
1
- import { DateLike, ExtraFields, ParseOptions } from "../../common/types.cjs";
1
+ import { ExtraFields, ParseMainOptions as ParseMainOptions$1, Requirable, Strict } from "../../common/types.cjs";
2
2
 
3
3
  //#region src/opml/common/types.d.ts
4
- type MainOptions<A extends ReadonlyArray<string> = ReadonlyArray<string>> = ParseOptions & {
5
- extraOutlineAttributes?: A;
4
+ type ParseMainOptions<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>> = ParseMainOptions$1<TDate> & {
5
+ extraOutlineAttributes?: TExtra;
6
+ };
7
+ type GenerateMainOptions<TExtra extends ReadonlyArray<string> = ReadonlyArray<string>> = {
8
+ extraOutlineAttributes?: TExtra;
6
9
  };
7
10
  declare namespace Opml {
8
- type Outline<TDate extends DateLike, A extends ReadonlyArray<string> = ReadonlyArray<string>> = {
9
- text: string;
11
+ type BaseOutline<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = Strict<{
12
+ text: Requirable<string>;
10
13
  type?: string;
11
14
  isComment?: boolean;
12
15
  isBreakpoint?: boolean;
@@ -19,9 +22,11 @@ declare namespace Opml {
19
22
  title?: string;
20
23
  version?: string;
21
24
  url?: string;
22
- outlines?: Array<Outline<TDate, A>>;
23
- } & ExtraFields<A>;
24
- type Head<TDate extends DateLike> = {
25
+ }, TStrict> & ExtraFields<TExtra>;
26
+ type Outline<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = BaseOutline<TDate, TExtra, TStrict> & {
27
+ outlines?: Array<Outline<TDate, TExtra, TStrict>>;
28
+ };
29
+ type Head<TDate> = {
25
30
  title?: string;
26
31
  dateCreated?: TDate;
27
32
  dateModified?: TDate;
@@ -36,13 +41,13 @@ declare namespace Opml {
36
41
  windowBottom?: number;
37
42
  windowRight?: number;
38
43
  };
39
- type Body<TDate extends DateLike, A extends ReadonlyArray<string> = ReadonlyArray<string>> = {
40
- outlines?: Array<Outline<TDate, A>>;
44
+ type Body<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = {
45
+ outlines?: Array<Outline<TDate, TExtra, TStrict>>;
41
46
  };
42
- type Document<TDate extends DateLike, A extends ReadonlyArray<string> = ReadonlyArray<string>> = {
47
+ type Document<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = {
43
48
  head?: Head<TDate>;
44
- body?: Body<TDate, A>;
49
+ body?: Body<TDate, TExtra, TStrict>;
45
50
  };
46
51
  }
47
52
  //#endregion
48
- export { MainOptions, Opml };
53
+ export { GenerateMainOptions, Opml, ParseMainOptions };
@@ -1,12 +1,15 @@
1
- import { DateLike, ExtraFields, ParseOptions } from "../../common/types.js";
1
+ import { ExtraFields, ParseMainOptions as ParseMainOptions$1, Requirable, Strict } from "../../common/types.js";
2
2
 
3
3
  //#region src/opml/common/types.d.ts
4
- type MainOptions<A extends ReadonlyArray<string> = ReadonlyArray<string>> = ParseOptions & {
5
- extraOutlineAttributes?: A;
4
+ type ParseMainOptions<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>> = ParseMainOptions$1<TDate> & {
5
+ extraOutlineAttributes?: TExtra;
6
+ };
7
+ type GenerateMainOptions<TExtra extends ReadonlyArray<string> = ReadonlyArray<string>> = {
8
+ extraOutlineAttributes?: TExtra;
6
9
  };
7
10
  declare namespace Opml {
8
- type Outline<TDate extends DateLike, A extends ReadonlyArray<string> = ReadonlyArray<string>> = {
9
- text: string;
11
+ type BaseOutline<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = Strict<{
12
+ text: Requirable<string>;
10
13
  type?: string;
11
14
  isComment?: boolean;
12
15
  isBreakpoint?: boolean;
@@ -19,9 +22,11 @@ declare namespace Opml {
19
22
  title?: string;
20
23
  version?: string;
21
24
  url?: string;
22
- outlines?: Array<Outline<TDate, A>>;
23
- } & ExtraFields<A>;
24
- type Head<TDate extends DateLike> = {
25
+ }, TStrict> & ExtraFields<TExtra>;
26
+ type Outline<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = BaseOutline<TDate, TExtra, TStrict> & {
27
+ outlines?: Array<Outline<TDate, TExtra, TStrict>>;
28
+ };
29
+ type Head<TDate> = {
25
30
  title?: string;
26
31
  dateCreated?: TDate;
27
32
  dateModified?: TDate;
@@ -36,13 +41,13 @@ declare namespace Opml {
36
41
  windowBottom?: number;
37
42
  windowRight?: number;
38
43
  };
39
- type Body<TDate extends DateLike, A extends ReadonlyArray<string> = ReadonlyArray<string>> = {
40
- outlines?: Array<Outline<TDate, A>>;
44
+ type Body<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = {
45
+ outlines?: Array<Outline<TDate, TExtra, TStrict>>;
41
46
  };
42
- type Document<TDate extends DateLike, A extends ReadonlyArray<string> = ReadonlyArray<string>> = {
47
+ type Document<TDate, TExtra extends ReadonlyArray<string> = ReadonlyArray<string>, TStrict extends boolean = false> = {
43
48
  head?: Head<TDate>;
44
- body?: Body<TDate, A>;
49
+ body?: Body<TDate, TExtra, TStrict>;
45
50
  };
46
51
  }
47
52
  //#endregion
48
- export { MainOptions, Opml };
53
+ export { GenerateMainOptions, Opml, ParseMainOptions };
@@ -1,3 +1,4 @@
1
+ const require_errors = require("../../common/errors.cjs");
1
2
  const require_config = require("../../common/config.cjs");
2
3
  const require_utils = require("../../common/utils.cjs");
3
4
  const require_config$1 = require("./config.cjs");
@@ -5,7 +6,7 @@ const require_utils$1 = require("./utils.cjs");
5
6
  //#region src/opml/generate/index.ts
6
7
  const generate = (value, options) => {
7
8
  const generated = require_utils$1.generateDocument(value, options);
8
- if (!generated) throw new Error(require_config.locales.invalidInputOpml);
9
+ if (!generated) throw new require_errors.GenerateError(require_config.locales.invalidInputOpml);
9
10
  return require_utils.generateXml(require_config$1.builder, generated, options);
10
11
  };
11
12
  //#endregion
@@ -1,7 +1,7 @@
1
- import { DateLike, DeepPartial, XmlGenerateOptions } from "../../common/types.cjs";
2
- import { MainOptions, Opml } from "../common/types.cjs";
1
+ import { DateLike, GenerateMainXmlOptions } from "../../common/types.cjs";
2
+ import { GenerateMainOptions, Opml } from "../common/types.cjs";
3
3
 
4
4
  //#region src/opml/generate/index.d.ts
5
- declare const generate: <A extends ReadonlyArray<string> = [], F extends boolean = false>(value: F extends true ? DeepPartial<Opml.Document<DateLike, A>> : Opml.Document<Date, A>, options?: XmlGenerateOptions<MainOptions<A>, F>) => string;
5
+ declare const generate: <TExtra extends ReadonlyArray<string> = [], S extends boolean = false>(value: S extends true ? Opml.Document<Date, TExtra, true> : Opml.Document<DateLike, TExtra>, options?: GenerateMainXmlOptions<GenerateMainOptions<TExtra>, S>) => string;
6
6
  //#endregion
7
7
  export { generate };
@@ -1,7 +1,7 @@
1
- import { DateLike, DeepPartial, XmlGenerateOptions } from "../../common/types.js";
2
- import { MainOptions, Opml } from "../common/types.js";
1
+ import { DateLike, GenerateMainXmlOptions } from "../../common/types.js";
2
+ import { GenerateMainOptions, Opml } from "../common/types.js";
3
3
 
4
4
  //#region src/opml/generate/index.d.ts
5
- declare const generate: <A extends ReadonlyArray<string> = [], F extends boolean = false>(value: F extends true ? DeepPartial<Opml.Document<DateLike, A>> : Opml.Document<Date, A>, options?: XmlGenerateOptions<MainOptions<A>, F>) => string;
5
+ declare const generate: <TExtra extends ReadonlyArray<string> = [], S extends boolean = false>(value: S extends true ? Opml.Document<Date, TExtra, true> : Opml.Document<DateLike, TExtra>, options?: GenerateMainXmlOptions<GenerateMainOptions<TExtra>, S>) => string;
6
6
  //#endregion
7
7
  export { generate };
@@ -1,3 +1,4 @@
1
+ import { GenerateError } from "../../common/errors.js";
1
2
  import { locales } from "../../common/config.js";
2
3
  import { generateXml } from "../../common/utils.js";
3
4
  import { builder } from "./config.js";
@@ -5,7 +6,7 @@ import { generateDocument } from "./utils.js";
5
6
  //#region src/opml/generate/index.ts
6
7
  const generate = (value, options) => {
7
8
  const generated = generateDocument(value, options);
8
- if (!generated) throw new Error(locales.invalidInputOpml);
9
+ if (!generated) throw new GenerateError(locales.invalidInputOpml);
9
10
  return generateXml(builder, generated, options);
10
11
  };
11
12
  //#endregion
@@ -1,10 +1,17 @@
1
+ const require_errors = require("../../common/errors.cjs");
1
2
  const require_config = require("../../common/config.cjs");
2
3
  const require_config$1 = require("./config.cjs");
3
4
  const require_utils = require("./utils.cjs");
4
5
  //#region src/opml/parse/index.ts
5
6
  const parse = (value, options) => {
6
- const parsed = require_utils.parseDocument(require_config$1.parser.parse(value), options);
7
- if (!parsed) throw new Error(require_config.locales.invalidOpmlFormat);
7
+ let object;
8
+ try {
9
+ object = require_config$1.parser.parse(value);
10
+ } catch {
11
+ throw new require_errors.MalformedError(require_config.locales.invalidOpmlFormat);
12
+ }
13
+ const parsed = require_utils.parseDocument(object, options);
14
+ if (!parsed) throw new require_errors.ParseError(require_config.locales.invalidOpmlFormat);
8
15
  return parsed;
9
16
  };
10
17
  //#endregion
@@ -1,7 +1,6 @@
1
- import { DeepPartial } from "../../common/types.cjs";
2
- import { MainOptions, Opml } from "../common/types.cjs";
1
+ import { Opml, ParseMainOptions } from "../common/types.cjs";
3
2
 
4
3
  //#region src/opml/parse/index.d.ts
5
- declare const parse: <const A extends ReadonlyArray<string> = ReadonlyArray<string>>(value: string, options?: MainOptions<A>) => DeepPartial<Opml.Document<string, A>>;
4
+ declare const parse: <TDate = string, const TExtra extends ReadonlyArray<string> = ReadonlyArray<string>>(value: string, options?: ParseMainOptions<TDate, TExtra>) => Opml.Document<TDate, TExtra>;
6
5
  //#endregion
7
6
  export { parse };
@@ -1,7 +1,6 @@
1
- import { DeepPartial } from "../../common/types.js";
2
- import { MainOptions, Opml } from "../common/types.js";
1
+ import { Opml, ParseMainOptions } from "../common/types.js";
3
2
 
4
3
  //#region src/opml/parse/index.d.ts
5
- declare const parse: <const A extends ReadonlyArray<string> = ReadonlyArray<string>>(value: string, options?: MainOptions<A>) => DeepPartial<Opml.Document<string, A>>;
4
+ declare const parse: <TDate = string, const TExtra extends ReadonlyArray<string> = ReadonlyArray<string>>(value: string, options?: ParseMainOptions<TDate, TExtra>) => Opml.Document<TDate, TExtra>;
6
5
  //#endregion
7
6
  export { parse };
@@ -1,10 +1,17 @@
1
+ import { MalformedError, ParseError } from "../../common/errors.js";
1
2
  import { locales } from "../../common/config.js";
2
3
  import { parser } from "./config.js";
3
4
  import { parseDocument } from "./utils.js";
4
5
  //#region src/opml/parse/index.ts
5
6
  const parse = (value, options) => {
6
- const parsed = parseDocument(parser.parse(value), options);
7
- if (!parsed) throw new Error(locales.invalidOpmlFormat);
7
+ let object;
8
+ try {
9
+ object = parser.parse(value);
10
+ } catch {
11
+ throw new MalformedError(locales.invalidOpmlFormat);
12
+ }
13
+ const parsed = parseDocument(object, options);
14
+ if (!parsed) throw new ParseError(locales.invalidOpmlFormat);
8
15
  return parsed;
9
16
  };
10
17
  //#endregion
@@ -7,7 +7,7 @@ const parseOutline = (value, options) => {
7
7
  type: require_utils.parseString(value["@type"]),
8
8
  isComment: require_utils.parseBoolean(value["@iscomment"]),
9
9
  isBreakpoint: require_utils.parseBoolean(value["@isbreakpoint"]),
10
- created: require_utils.parseDate(value["@created"]),
10
+ created: require_utils.parseDate(value["@created"], options?.parseDateFn),
11
11
  category: require_utils.parseString(value["@category"]),
12
12
  description: require_utils.parseString(value["@description"]),
13
13
  xmlUrl: require_utils.parseString(value["@xmlurl"]),
@@ -25,12 +25,12 @@ const parseOutline = (value, options) => {
25
25
  }
26
26
  return require_utils.trimObject(outline);
27
27
  };
28
- const parseHead = (value) => {
28
+ const parseHead = (value, options) => {
29
29
  if (!require_utils.isObject(value)) return;
30
30
  return require_utils.trimObject({
31
31
  title: require_utils.parseSingularOf(value.title, (value) => require_utils.parseString(require_utils.retrieveText(value))),
32
- dateCreated: require_utils.parseSingularOf(value.datecreated, (value) => require_utils.parseDate(require_utils.retrieveText(value))),
33
- dateModified: require_utils.parseSingularOf(value.datemodified, (value) => require_utils.parseDate(require_utils.retrieveText(value))),
32
+ dateCreated: require_utils.parseSingularOf(value.datecreated, (value) => require_utils.parseDate(require_utils.retrieveText(value), options?.parseDateFn)),
33
+ dateModified: require_utils.parseSingularOf(value.datemodified, (value) => require_utils.parseDate(require_utils.retrieveText(value), options?.parseDateFn)),
34
34
  ownerName: require_utils.parseSingularOf(value.ownername, (value) => require_utils.parseString(require_utils.retrieveText(value))),
35
35
  ownerEmail: require_utils.parseSingularOf(value.owneremail, (value) => require_utils.parseString(require_utils.retrieveText(value))),
36
36
  ownerId: require_utils.parseSingularOf(value.ownerid, (value) => require_utils.parseString(require_utils.retrieveText(value))),
@@ -50,7 +50,7 @@ const parseBody = (value, options) => {
50
50
  const parseDocument = (value, options) => {
51
51
  if (!require_utils.isObject(value?.opml)) return;
52
52
  return require_utils.trimObject({
53
- head: parseHead(value.opml.head),
53
+ head: parseHead(value.opml.head, options),
54
54
  body: parseBody(value.opml.body, options)
55
55
  });
56
56
  };
@@ -7,7 +7,7 @@ const parseOutline = (value, options) => {
7
7
  type: parseString(value["@type"]),
8
8
  isComment: parseBoolean(value["@iscomment"]),
9
9
  isBreakpoint: parseBoolean(value["@isbreakpoint"]),
10
- created: parseDate(value["@created"]),
10
+ created: parseDate(value["@created"], options?.parseDateFn),
11
11
  category: parseString(value["@category"]),
12
12
  description: parseString(value["@description"]),
13
13
  xmlUrl: parseString(value["@xmlurl"]),
@@ -25,12 +25,12 @@ const parseOutline = (value, options) => {
25
25
  }
26
26
  return trimObject(outline);
27
27
  };
28
- const parseHead = (value) => {
28
+ const parseHead = (value, options) => {
29
29
  if (!isObject(value)) return;
30
30
  return trimObject({
31
31
  title: parseSingularOf(value.title, (value) => parseString(retrieveText(value))),
32
- dateCreated: parseSingularOf(value.datecreated, (value) => parseDate(retrieveText(value))),
33
- dateModified: parseSingularOf(value.datemodified, (value) => parseDate(retrieveText(value))),
32
+ dateCreated: parseSingularOf(value.datecreated, (value) => parseDate(retrieveText(value), options?.parseDateFn)),
33
+ dateModified: parseSingularOf(value.datemodified, (value) => parseDate(retrieveText(value), options?.parseDateFn)),
34
34
  ownerName: parseSingularOf(value.ownername, (value) => parseString(retrieveText(value))),
35
35
  ownerEmail: parseSingularOf(value.owneremail, (value) => parseString(retrieveText(value))),
36
36
  ownerId: parseSingularOf(value.ownerid, (value) => parseString(retrieveText(value))),
@@ -50,7 +50,7 @@ const parseBody = (value, options) => {
50
50
  const parseDocument = (value, options) => {
51
51
  if (!isObject(value?.opml)) return;
52
52
  return trimObject({
53
- head: parseHead(value.opml.head),
53
+ head: parseHead(value.opml.head, options),
54
54
  body: parseBody(value.opml.body, options)
55
55
  });
56
56
  };
package/package.json CHANGED
@@ -31,13 +31,6 @@
31
31
  "type": "module",
32
32
  "main": "./dist/index.cjs",
33
33
  "types": "./dist/index.d.cts",
34
- "typesVersions": {
35
- "*": {
36
- "types": [
37
- "./dist/types.d.ts"
38
- ]
39
- }
40
- },
41
34
  "exports": {
42
35
  ".": {
43
36
  "import": {
@@ -49,16 +42,6 @@
49
42
  "default": "./dist/index.cjs"
50
43
  }
51
44
  },
52
- "./types": {
53
- "import": {
54
- "types": "./dist/types.d.ts",
55
- "default": "./dist/types.js"
56
- },
57
- "require": {
58
- "types": "./dist/types.d.cts",
59
- "default": "./dist/types.cjs"
60
- }
61
- },
62
45
  "./package.json": "./package.json"
63
46
  },
64
47
  "files": [
@@ -66,7 +49,7 @@
66
49
  ],
67
50
  "scripts": {
68
51
  "prepare": "lefthook install",
69
- "build": "tsdown src/index.ts src/types.ts --format cjs,esm --dts --clean --unbundle --no-fixed-extension",
52
+ "build": "tsdown src/index.ts --format cjs,esm --dts --clean --unbundle --no-fixed-extension",
70
53
  "docs:dev": "vitepress dev docs",
71
54
  "docs:build": "vitepress build docs"
72
55
  },
@@ -80,5 +63,5 @@
80
63
  "tsdown": "^0.21.8",
81
64
  "vitepress": "^2.0.0-alpha.17"
82
65
  },
83
- "version": "2.9.2"
66
+ "version": "3.0.0-beta.2"
84
67
  }
package/dist/types.cjs DELETED
File without changes
package/dist/types.d.cts DELETED
@@ -1,7 +0,0 @@
1
- import { DeepPartial } from "./common/types.cjs";
2
- import { Atom } from "./feeds/atom/common/types.cjs";
3
- import { Json } from "./feeds/json/common/types.cjs";
4
- import { Rdf } from "./feeds/rdf/common/types.cjs";
5
- import { Rss } from "./feeds/rss/common/types.cjs";
6
- import { Opml } from "./opml/common/types.cjs";
7
- export { type Atom, type DeepPartial, type Json, type Opml, type Rdf, type Rss };