@readium/shared 2.2.2 → 2.3.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 (174) hide show
  1. package/README.MD +8 -7
  2. package/dist/_virtual/preload-helper.js +1 -0
  3. package/dist/fetcher/Fetcher.js +1 -0
  4. package/dist/fetcher/HttpFetcher.js +1 -0
  5. package/dist/fetcher/Resource.js +1 -0
  6. package/dist/index.js +1 -4972
  7. package/dist/locales/publication-metadata/ar.json.js +1 -0
  8. package/dist/locales/publication-metadata/da.json.js +1 -0
  9. package/dist/locales/publication-metadata/el.json.js +1 -0
  10. package/dist/locales/publication-metadata/en.json.js +1 -0
  11. package/dist/locales/publication-metadata/es.json.js +1 -0
  12. package/dist/locales/publication-metadata/et.json.js +1 -0
  13. package/dist/locales/publication-metadata/fi.json.js +1 -0
  14. package/dist/locales/publication-metadata/fr.json.js +1 -0
  15. package/dist/locales/publication-metadata/it.json.js +1 -0
  16. package/dist/locales/publication-metadata/pl.json.js +1 -0
  17. package/dist/locales/publication-metadata/pt_PT.json.js +1 -0
  18. package/dist/locales/publication-metadata/sv.json.js +1 -0
  19. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/constants.js +1 -0
  20. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/index.js +1 -0
  21. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/selector-attribute.js +1 -0
  22. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/selector-class.js +1 -0
  23. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/selector-fallback.js +1 -0
  24. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/selector-id.js +1 -0
  25. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/selector-nth-child.js +1 -0
  26. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/selector-nth-of-type.js +1 -0
  27. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/selector-tag.js +1 -0
  28. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/types.js +1 -0
  29. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-cartesian.js +1 -0
  30. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-data.js +1 -0
  31. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-dom.js +1 -0
  32. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-element-data.js +1 -0
  33. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-iselement.js +1 -0
  34. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-messages.js +1 -0
  35. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-options.js +1 -0
  36. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-powerset.js +1 -0
  37. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-selectors.js +1 -0
  38. package/dist/node_modules/.pnpm/css-selector-generator@3.8.0/node_modules/css-selector-generator/esm/utilities-typescript.js +1 -0
  39. package/dist/opds/Acquisition.js +1 -0
  40. package/dist/opds/Availability.js +1 -0
  41. package/dist/opds/Copies.js +1 -0
  42. package/dist/opds/Holds.js +1 -0
  43. package/dist/opds/Price.js +1 -0
  44. package/dist/publication/AltIdentifier.js +1 -0
  45. package/dist/publication/BelongsTo.js +1 -0
  46. package/dist/publication/Contributor.js +1 -0
  47. package/dist/publication/GuidedNavigation.js +1 -0
  48. package/dist/publication/Layout.js +1 -0
  49. package/dist/publication/Link.js +1 -0
  50. package/dist/publication/LocalizedString.js +1 -0
  51. package/dist/publication/Locator.js +1 -0
  52. package/dist/publication/LocatorCollection.js +1 -0
  53. package/dist/publication/Manifest.js +1 -0
  54. package/dist/publication/Metadata.js +1 -0
  55. package/dist/publication/Profiles.js +1 -0
  56. package/dist/publication/Properties.js +1 -0
  57. package/dist/publication/Publication.js +1 -0
  58. package/dist/publication/PublicationCollection.js +1 -0
  59. package/dist/publication/ReadingProgression.js +1 -0
  60. package/dist/publication/Subject.js +1 -0
  61. package/dist/publication/TDM.js +1 -0
  62. package/dist/publication/accessibility/Accessibility.js +1 -0
  63. package/dist/publication/accessibility/AccessibilityMetadataDisplayGuide.js +1 -0
  64. package/dist/publication/accessibility/Localization.js +1 -0
  65. package/dist/publication/accessibility/SupportedLanguages.js +1 -0
  66. package/dist/publication/encryption/Encryption.js +1 -0
  67. package/dist/publication/encryption/Properties.js +1 -0
  68. package/dist/publication/encryption/index.js +1 -0
  69. package/dist/publication/epub/MediaOverlay.js +1 -0
  70. package/dist/publication/epub/Metadata.js +1 -0
  71. package/dist/publication/epub/Properties.js +1 -0
  72. package/dist/publication/epub/Publication.js +1 -0
  73. package/dist/publication/epub/index.js +1 -0
  74. package/dist/publication/html/DomRange.js +1 -0
  75. package/dist/publication/html/DomRangePoint.js +1 -0
  76. package/dist/publication/html/Locations.js +1 -0
  77. package/dist/publication/html/index.js +1 -0
  78. package/dist/publication/opds/Properties.js +1 -0
  79. package/dist/publication/opds/Publication.js +1 -0
  80. package/dist/publication/opds/index.js +1 -0
  81. package/dist/publication/services/content/Content.js +2 -0
  82. package/dist/publication/services/content/ContentTokenizer.js +1 -0
  83. package/dist/publication/services/content/Iterator.js +1 -0
  84. package/dist/publication/services/content/element/attributes.js +1 -0
  85. package/dist/publication/services/content/element/element.js +1 -0
  86. package/dist/publication/services/content/element/text_role.js +1 -0
  87. package/dist/publication/services/content/iterators/HTMLResourceContentIterator.js +1 -0
  88. package/dist/publication/services/content/iterators/PDFTextContentIterator.js +1 -0
  89. package/dist/publication/services/content/iterators/PublicationContentIterator.js +1 -0
  90. package/dist/publication/services/content/iterators/helpers.js +1 -0
  91. package/dist/publication/services/timeline/Timeline.js +1 -0
  92. package/dist/publication/services/timeline/audio.js +1 -0
  93. package/dist/publication/services/timeline/html.js +1 -0
  94. package/dist/publication/services/timeline/index.js +1 -0
  95. package/dist/util/JSONParse.js +1 -0
  96. package/dist/util/URITemplate.js +1 -0
  97. package/dist/util/mediatype/MediaType.js +1 -0
  98. package/dist/util/npt.js +1 -0
  99. package/dist/util/tokenizer/TextTokenizer.js +1 -0
  100. package/dist/util/tokenizer/tokenize-english/abbreviations.js +1 -0
  101. package/dist/util/tokenizer/tokenize-english/index.js +2 -0
  102. package/dist/util/tokenizer/tokenize-english/utils.js +1 -0
  103. package/dist/util/tokenizer/tokenize-text/index.js +1 -0
  104. package/dist/util/tokenizer/tokenize-text/tokens.js +1 -0
  105. package/package.json +26 -19
  106. package/src/locales/publication-metadata/ar.json +402 -0
  107. package/src/locales/publication-metadata/brh.json +1 -0
  108. package/src/locales/publication-metadata/da.json +310 -0
  109. package/src/locales/publication-metadata/el.json +310 -0
  110. package/src/locales/publication-metadata/en.json +310 -0
  111. package/src/locales/publication-metadata/es.json +333 -0
  112. package/src/locales/publication-metadata/et.json +310 -0
  113. package/src/locales/publication-metadata/fi.json +310 -0
  114. package/src/locales/publication-metadata/fr.json +333 -0
  115. package/src/locales/publication-metadata/he.json +9 -0
  116. package/src/locales/publication-metadata/it.json +333 -0
  117. package/src/locales/publication-metadata/lt.json +8 -0
  118. package/src/locales/publication-metadata/pl.json +333 -0
  119. package/src/locales/publication-metadata/pt_PT.json +329 -0
  120. package/src/locales/publication-metadata/sv.json +310 -0
  121. package/src/locales/publication-metadata/tr.json +51 -0
  122. package/src/locales/publication-metadata/uk.json +1 -0
  123. package/src/opds/Acquisition.ts +1 -1
  124. package/src/opds/Availability.ts +1 -1
  125. package/src/opds/Copies.ts +1 -1
  126. package/src/opds/Holds.ts +1 -1
  127. package/src/opds/Price.ts +1 -1
  128. package/src/publication/Link.ts +2 -6
  129. package/src/publication/Locator.ts +21 -3
  130. package/src/publication/Manifest.ts +5 -7
  131. package/src/publication/Publication.ts +2 -1
  132. package/src/publication/accessibility/Localization.ts +12 -14
  133. package/src/publication/accessibility/SupportedLanguages.ts +1 -1
  134. package/src/publication/encryption/Properties.ts +3 -15
  135. package/src/publication/epub/Metadata.ts +6 -12
  136. package/src/publication/epub/Properties.ts +3 -13
  137. package/src/publication/epub/Publication.ts +18 -39
  138. package/src/publication/html/Locations.ts +57 -104
  139. package/src/publication/opds/Properties.ts +22 -67
  140. package/src/publication/opds/Publication.ts +3 -9
  141. package/src/publication/services/content/iterators/HTMLResourceContentIterator.ts +3 -1
  142. package/src/publication/services/timeline/Timeline.ts +274 -65
  143. package/src/publication/services/timeline/TimelineItem.ts +3 -3
  144. package/src/publication/services/timeline/audio.ts +31 -0
  145. package/src/publication/services/timeline/html.ts +5 -0
  146. package/src/publication/services/timeline/index.ts +12 -0
  147. package/src/util/index.ts +1 -0
  148. package/src/util/npt.ts +70 -0
  149. package/types/src/opds/Acquisition.d.ts +1 -1
  150. package/types/src/opds/Availability.d.ts +1 -1
  151. package/types/src/opds/Copies.d.ts +1 -1
  152. package/types/src/opds/Holds.d.ts +1 -1
  153. package/types/src/opds/Price.d.ts +1 -1
  154. package/types/src/publication/encryption/Properties.d.ts +2 -9
  155. package/types/src/publication/epub/Metadata.d.ts +3 -6
  156. package/types/src/publication/epub/Properties.d.ts +2 -10
  157. package/types/src/publication/epub/Publication.d.ts +7 -18
  158. package/types/src/publication/html/Locations.d.ts +15 -44
  159. package/types/src/publication/opds/Properties.d.ts +8 -36
  160. package/types/src/publication/opds/Publication.d.ts +2 -5
  161. package/types/src/publication/services/timeline/Timeline.d.ts +80 -15
  162. package/types/src/publication/services/timeline/TimelineItem.d.ts +3 -3
  163. package/types/src/publication/services/timeline/audio.d.ts +4 -0
  164. package/types/src/publication/services/timeline/html.d.ts +4 -0
  165. package/types/src/publication/services/timeline/index.d.ts +6 -0
  166. package/types/src/util/index.d.ts +1 -0
  167. package/types/src/util/npt.d.ts +30 -0
  168. package/dist/ar-DyHX_uy2.js +0 -7
  169. package/dist/da-Dct0PS3E.js +0 -7
  170. package/dist/fr-C5HEel98.js +0 -7
  171. package/dist/index.umd.cjs +0 -3
  172. package/dist/it-DFOBoXGy.js +0 -7
  173. package/dist/pt_PT-Di3sVjze.js +0 -7
  174. package/dist/sv-BfzAFsVN.js +0 -7
@@ -3,82 +3,37 @@ import { positiveNumberfromJSON } from '../../util/JSONParse.ts';
3
3
  import { Link } from '../Link.ts';
4
4
  import { Properties } from '../Properties.ts';
5
5
 
6
- // OPDS extensions for link [Properties].
7
- // https://drafts.opds.io/schema/properties.schema.json
6
+ // OPDS extensions for link Properties.
7
+ // https://specs.opds.io/schema/properties.schema.json
8
8
 
9
- declare module '../Properties' {
10
- export interface Properties {
11
- /**
12
- * Provides a hint about the expected number of items returned.
13
- */
14
- getNumberOfItems(): number | undefined;
15
-
16
- /**
17
- * The price of a publication is tied to its acquisition link.
18
- */
19
- getPrice(): Price | undefined;
20
-
21
- /**
22
- * Indirect acquisition provides a hint for the expected media type that will be acquired after
23
- * additional steps.
24
- */
25
- getIndirectAcquisitions(): Array<Acquisition> | undefined;
26
-
27
- /**
28
- * Library-specific features when a specific book is unavailable but provides a hold list.
29
- */
30
- getHolds(): Holds | undefined;
31
-
32
- /**
33
- * Library-specific feature that contains information about the copies that a library has acquired.
34
- */
35
- getCopies(): Copies | undefined;
36
-
37
- /**
38
- * Indicated the availability of a given resource.
39
- */
40
- getAvailability(): Availability | undefined;
41
-
42
- /**
43
- * Indicates that the linked resource supports authentication with the associated Authentication
44
- * Document.
45
- *
46
- * See https://drafts.opds.io/authentication-for-opds-1.0.html
47
- */
48
- getAuthenticate(): Link | undefined;
49
- }
9
+ export function getNumberOfItems(properties: Properties): number | undefined {
10
+ return positiveNumberfromJSON(properties.otherProperties['numberOfItems']);
50
11
  }
51
12
 
52
- Properties.prototype.getNumberOfItems = function(): number | undefined {
53
- return positiveNumberfromJSON(this.otherProperties['numberOfItems']);
54
- };
55
-
56
- Properties.prototype.getPrice = function(): Price | undefined {
57
- return Price.deserialize(this.otherProperties['price']);
58
- };
13
+ export function getPrice(properties: Properties): Price | undefined {
14
+ return Price.deserialize(properties.otherProperties['price']);
15
+ }
59
16
 
60
- Properties.prototype.getIndirectAcquisitions = function():
61
- | Array<Acquisition>
62
- | undefined {
63
- const json = this.otherProperties['indirectAcquisition'];
17
+ export function getIndirectAcquisitions(properties: Properties): Array<Acquisition> | undefined {
18
+ const json = properties.otherProperties['indirectAcquisition'];
64
19
  if (!(json && Array.isArray(json))) return;
65
20
  return json
66
21
  .map<Acquisition>(item => Acquisition.deserialize(item) as Acquisition)
67
22
  .filter(x => x !== undefined);
68
- };
23
+ }
69
24
 
70
- Properties.prototype.getHolds = function(): Holds | undefined {
71
- return Holds.deserialize(this.otherProperties['holds']);
72
- };
25
+ export function getHolds(properties: Properties): Holds | undefined {
26
+ return Holds.deserialize(properties.otherProperties['holds']);
27
+ }
73
28
 
74
- Properties.prototype.getCopies = function(): Copies | undefined {
75
- return Copies.deserialize(this.otherProperties['copies']);
76
- };
29
+ export function getCopies(properties: Properties): Copies | undefined {
30
+ return Copies.deserialize(properties.otherProperties['copies']);
31
+ }
77
32
 
78
- Properties.prototype.getAvailability = function(): Availability | undefined {
79
- return Availability.deserialize(this.otherProperties['availability']);
80
- };
33
+ export function getAvailability(properties: Properties): Availability | undefined {
34
+ return Availability.deserialize(properties.otherProperties['availability']);
35
+ }
81
36
 
82
- Properties.prototype.getAuthenticate = function(): Link | undefined {
83
- return Link.deserialize(this.otherProperties['authenticate']);
84
- };
37
+ export function getAuthenticate(properties: Properties): Link | undefined {
38
+ return Link.deserialize(properties.otherProperties['authenticate']);
39
+ }
@@ -1,14 +1,8 @@
1
1
  import { Links } from '../Link.ts';
2
2
  import { Publication } from '../Publication.ts';
3
3
 
4
- // OPDS extensions for [Publication]
4
+ // OPDS extensions for Publication.
5
5
 
6
- declare module '../Publication' {
7
- export interface Publication {
8
- getImages(): Links | undefined;
9
- }
6
+ export function getImages(pub: Publication): Links | undefined {
7
+ return pub.linksWithRole('images');
10
8
  }
11
-
12
- Publication.prototype.getImages = function(): Links | undefined {
13
- return this.linksWithRole('images');
14
- };
@@ -5,6 +5,7 @@ import { IllegalStateError, Iterator } from "../Iterator.ts";
5
5
  import { Attribute, AttributeKeys, AudioElement, Body, ContentElement, Footnote, Heading, ImageElement, TextElement, TextQuote, TextRole, TextSegment, VideoElement } from "../element/index.ts";
6
6
  import { appendNormalizedWhitespace, elementLanguage, isBlank, isInlineTag, srcRelativeToHref, trimUnicodeSpace, trimUnicodeSpaceEnd, trimUnicodeSpaceStart, trimmingTextLocator } from "./helpers.ts";
7
7
  import { getCssSelector } from "css-selector-generator";
8
+ import { getCssSelector as locatorCssSelector } from "../../../html/Locations.ts";
8
9
 
9
10
  interface ElementWithDelta {
10
11
  element: ContentElement;
@@ -93,10 +94,11 @@ export class HTMLResourceContentIterator extends Iterator {
93
94
  private async parseElements(): Promise<ParsedElementRecipes> {
94
95
  const raw = await this.resource.readAsString();
95
96
  const doc = (new DOMParser()).parseFromString(raw!, this.locator.type as DOMParserSupportedType);
97
+ const startSel = locatorCssSelector(this.locator.locations);
96
98
  this.parser = new ContentParser(
97
99
  doc,
98
100
  this.locator,
99
- this.locator.locations.getCssSelector() ? doc.querySelector(this.locator.locations.getCssSelector()!) as Element : null,
101
+ startSel ? doc.querySelector(startSel) as Element : null,
100
102
  this.beforeMaxLength
101
103
  );
102
104
 
@@ -1,10 +1,31 @@
1
1
  import { Link, Links } from "../../Link.ts";
2
2
  import { Locator } from "../../Locator.ts";
3
+ import { getHtmlId, getTime } from "../../html/Locations.ts";
4
+ import { Profile } from "../../Profiles.ts";
5
+ import { formatNptTime, isNptStartOfResource, parseNptTime } from "../../../util/npt.ts";
3
6
  import { TimelineItem } from "./TimelineItem.ts";
4
7
 
5
- interface PublicationLike {
8
+ export interface PublicationLike {
6
9
  toc?: Links;
7
10
  readingOrder: Links;
11
+ metadata?: { conformsTo?: Profile[] };
12
+ }
13
+
14
+ /**
15
+ * A TOC entry, mirroring `publication.toc`'s authored hierarchy and
16
+ * contextualized with display-ready progression. When a publication has no
17
+ * `toc` at all, falls back to one flat entry per reading-order item.
18
+ *
19
+ * Exactly one of `position`/`timestamp` is populated, depending on the
20
+ * publication's profile.
21
+ */
22
+ export interface ContextualizedTocEntry {
23
+ link: Link;
24
+ /** Display-ready label for non-audio profiles: a Positions List position for EPUB, a page number for PDF (e.g. "42"). */
25
+ position?: string;
26
+ /** Display-ready formatted time for audiobooks (e.g. "27:27"). */
27
+ timestamp?: string;
28
+ children?: ContextualizedTocEntry[];
8
29
  }
9
30
 
10
31
  /**
@@ -16,32 +37,61 @@ interface PublicationLike {
16
37
  * 2. Populate flat children — all TOC fragment entries that reference the
17
38
  * resource, collected depth-first in TOC declaration order.
18
39
  *
19
- * No TOC hierarchy is reconstructed; that requires role context and is not yet
20
- * implemented. TOC entries whose href does not match any reading order item
21
- * are ignored.
40
+ * `contextualizedToc` returns the authored TOC hierarchy (see
41
+ * `ContextualizedTocEntry`), each entry contextualized with progression.
42
+ * `tocEntryFor(item)` maps a `TimelineItem` (e.g. from
43
+ * `locate()`) back to its entry in that hierarchy. TOC entries whose href
44
+ * does not match any reading order item are ignored.
22
45
  *
23
- * The `depth` build option limits how many levels deep into the TOC tree both
24
- * title resolution and child collection may look. Level 1 = top-level TOC
25
- * entries; level 2 = their children; etc. `undefined` means no limit.
46
+ * The `depth` build option limits how many levels deep into the TOC tree
47
+ * title resolution, child collection, and `contextualizedToc` traversal may
48
+ * look. Level 1 = top-level TOC entries; level 2 = their children; etc.
49
+ * `undefined` means no limit.
26
50
  */
27
51
  export class Timeline {
28
52
  private readonly _allItems: TimelineItem[];
29
53
  private readonly linkMap: Map<TimelineItem, Link>;
54
+ private readonly _conformsTo: readonly Profile[];
55
+ private readonly tocLinks: Link[];
30
56
  private _depth: number | undefined;
57
+ /**
58
+ * Depth used for `contextualizedToc` traversal. Tracks `_depth`, but is
59
+ * seeded independently from `Timeline.build()`'s `depth` option: unlike
60
+ * `_depth`, which only ever triggers `items`/`flat` re-trimming via the
61
+ * runtime `depth` setter, the TOC tree is walked fresh from `tocLinks`
62
+ * every time, so there's no equivalent "already baked in, don't reapply"
63
+ * hazard to avoid.
64
+ */
65
+ private _tocDepth: number | undefined;
31
66
  private _items: TimelineItem[] | undefined;
32
67
  private _flat: TimelineItem[] | undefined;
68
+ private _toc: ContextualizedTocEntry[] | undefined;
69
+ private _linkToItem: Map<Link, TimelineItem> | undefined;
33
70
  /** Populated when depth is set; maps cloned items from trimToDepth back to their Links. */
34
71
  private _trimmedLinkMap: Map<TimelineItem, Link> = new Map();
35
72
 
36
- constructor(items: TimelineItem[], linkMap: Map<TimelineItem, Link>) {
73
+ constructor(
74
+ items: TimelineItem[],
75
+ linkMap: Map<TimelineItem, Link>,
76
+ conformsTo: readonly Profile[] = [],
77
+ tocLinks: Link[] = [],
78
+ tocDepth: number | undefined = undefined,
79
+ ) {
37
80
  this._allItems = items;
38
81
  this.linkMap = linkMap;
82
+ this._conformsTo = conformsTo;
83
+ this.tocLinks = tocLinks;
84
+ this._tocDepth = tocDepth;
39
85
  }
40
86
 
41
- static build(publication: PublicationLike, options: { depth?: number } = {}): Timeline {
87
+ static build(
88
+ publication: PublicationLike,
89
+ options: { depth?: number } = {},
90
+ ): Timeline {
42
91
  const tocLinks = publication.toc?.items ?? [];
43
92
  const roLinks = publication.readingOrder.items;
44
93
  const { depth } = options;
94
+ const conformsTo = publication.metadata?.conformsTo ?? [];
45
95
  const linkMap = new Map<TimelineItem, Link>();
46
96
  const items: TimelineItem[] = [];
47
97
 
@@ -51,8 +101,7 @@ export class Timeline {
51
101
 
52
102
  const title =
53
103
  ro.title ??
54
- Timeline.findTitleInToc(tocLinks, bare, depth) ??
55
- `Resource ${i + 1}`;
104
+ Timeline.findTitleInToc(tocLinks, bare, depth);
56
105
 
57
106
  const tocChildren = Timeline.collectChildrenFromToc(tocLinks, bare, depth, 1, linkMap);
58
107
 
@@ -66,7 +115,25 @@ export class Timeline {
66
115
  items.push(item);
67
116
  }
68
117
 
69
- return new Timeline(items, linkMap);
118
+ return new Timeline(items, linkMap, conformsTo, tocLinks, depth);
119
+ }
120
+
121
+ /**
122
+ * Augments all items in the timeline by applying the mapper's returned patch.
123
+ * The mapper receives the item and its original manifest Link, and returns
124
+ * a partial TimelineItem — any fields it sets will overwrite the item's
125
+ * current value. Use this to populate `position`, `scroll`, `role`, or any
126
+ * future TimelineItem fields from format-specific data.
127
+ */
128
+ augment(mapper: (item: TimelineItem, link: Link) => Partial<TimelineItem>): void {
129
+ for (const item of this.flatAll) {
130
+ const link = this.linkFor(item);
131
+ if (!link) continue;
132
+ const patch = mapper(item, link);
133
+ if (patch.position !== undefined) item.position = patch.position;
134
+ if (patch.scroll !== undefined) item.scroll = patch.scroll;
135
+ if (patch.role !== undefined) item.role = patch.role;
136
+ }
70
137
  }
71
138
 
72
139
  /**
@@ -81,8 +148,10 @@ export class Timeline {
81
148
  set depth(value: number | undefined) {
82
149
  if (this._depth === value) return;
83
150
  this._depth = value;
151
+ this._tocDepth = value;
84
152
  this._items = undefined;
85
153
  this._flat = undefined;
154
+ this._toc = undefined;
86
155
  }
87
156
 
88
157
  /** Top-level timeline items. Cached; invalidated when `depth` changes. */
@@ -100,26 +169,63 @@ export class Timeline {
100
169
 
101
170
  locate(locator: Locator): TimelineItem | undefined {
102
171
  const href = locator.href.split("#")[0];
103
- const time = locator.locations?.time();
104
-
105
- let match: TimelineItem | undefined;
172
+ const time = getTime(locator.locations);
173
+ const htmlId = getHtmlId(locator.locations);
174
+ const progression = locator.locations.progression;
106
175
 
176
+ // Audio: best-match on t= start time.
107
177
  if (time !== undefined) {
108
178
  let bestTime = -Infinity;
179
+ let match: TimelineItem | undefined;
109
180
  for (const item of this.flat) {
181
+ if (!this.itemMatchesHref(item, href)) continue;
110
182
  const t = this.itemStartTime(item, href);
111
183
  if (t !== undefined && t <= time && t > bestTime) {
112
184
  bestTime = t;
113
185
  match = item;
114
186
  }
115
187
  }
188
+ if (match) return match;
189
+ }
190
+
191
+ // EPUB: match on HTML ID fragment.
192
+ if (htmlId) {
193
+ const match = this.flat.find(item => {
194
+ if (!this.itemMatchesHref(item, href)) return false;
195
+ return item.references.some(ref => ref.split("#")[1] === htmlId);
196
+ });
197
+ if (match) return match;
116
198
  }
117
199
 
118
- if (!match) {
119
- match = this.flat.find(item => this.bareHrefFromItem(item) === href);
200
+ // EPUB: best-match on scroll progression.
201
+ if (progression !== undefined) {
202
+ let bestScroll = -Infinity;
203
+ let match: TimelineItem | undefined;
204
+ for (const item of this.flat) {
205
+ if (!this.itemMatchesHref(item, href)) continue;
206
+ const s = this.itemScrollPosition(item);
207
+ if (s !== undefined && s <= progression && s > bestScroll) {
208
+ bestScroll = s;
209
+ match = item;
210
+ }
211
+ }
212
+ if (match) return match;
213
+
214
+ // No scroll data resolved anywhere in this resource yet: guess a
215
+ // child by evenly dividing the fraction across its children,
216
+ // rather than naming the whole resource.
217
+ const container = this.items.find(i => this.itemMatchesHref(i, href));
218
+ if (container?.children?.length && !container.children.some(c => c.scroll !== undefined)) {
219
+ const index = Math.min(
220
+ Math.floor(progression * container.children.length),
221
+ container.children.length - 1,
222
+ );
223
+ return container.children[index];
224
+ }
120
225
  }
121
226
 
122
- return match;
227
+ // Fallback: bare href match.
228
+ return this.flat.find(item => this.itemMatchesHref(item, href));
123
229
  }
124
230
 
125
231
  adjacentTo(item: TimelineItem): { previous: TimelineItem | undefined; next: TimelineItem | undefined } {
@@ -132,35 +238,11 @@ export class Timeline {
132
238
 
133
239
  segmentsForHref(href: string): TimelineItem[] {
134
240
  const bare = href.split("#")[0];
135
- const item = this.items.find(i => this.bareHrefFromItem(i) === bare);
241
+ const item = this.items.find(i => this.itemMatchesHref(i, bare));
136
242
  if (!item) return [];
137
243
  return item.children?.length ? item.children : [item];
138
244
  }
139
245
 
140
- itemAtProgression(href: string, progression: number, duration?: number): TimelineItem | undefined {
141
- const bare = href.split("#")[0];
142
- const item = this.items.find(i => this.bareHrefFromItem(i) === bare);
143
- if (!item) return undefined;
144
- if (!item.children?.length) return item;
145
-
146
- if (duration !== undefined) {
147
- const time = progression * duration;
148
- let match: TimelineItem = item;
149
- let bestTime = -Infinity;
150
- for (const child of item.children) {
151
- const t = this.timeFromItem(child);
152
- if (t !== undefined && t <= time && t > bestTime) {
153
- bestTime = t;
154
- match = child;
155
- }
156
- }
157
- return match;
158
- }
159
-
160
- const index = Math.min(Math.floor(progression * item.children.length), item.children.length - 1);
161
- return item.children[index];
162
- }
163
-
164
246
  ancestors(item: TimelineItem): TimelineItem[] {
165
247
  return this.ancestorPath(this.items, item) ?? [];
166
248
  }
@@ -169,11 +251,47 @@ export class Timeline {
169
251
  return this.linkMap.get(item) ?? this._trimmedLinkMap.get(item);
170
252
  }
171
253
 
254
+ /**
255
+ * The authored TOC, contextualized with display-ready progression. Mirrors
256
+ * `publication.toc`'s authored hierarchy (respecting `depth`), falling
257
+ * back to one flat entry per reading-order item when there's no toc at
258
+ * all. Cached; invalidated when `depth` changes.
259
+ */
260
+ get contextualizedToc(): ContextualizedTocEntry[] {
261
+ if (!this._toc) {
262
+ this._toc = this.tocLinks.length > 0
263
+ ? this.buildTocEntries(this.tocLinks, this._tocDepth, 1)
264
+ : this._allItems.map(item => this.entryFor(this.linkFor(item)!, item));
265
+ }
266
+ return this._toc;
267
+ }
268
+
269
+ /**
270
+ * Maps a `TimelineItem` (typically from `locate()`) to its `ContextualizedTocEntry`:
271
+ * a direct match first, falling back to the nearest preceding toc entry
272
+ * for that resource when there's no exact match (e.g. a mid-resource
273
+ * audio position between chapter markers).
274
+ */
275
+ tocEntryFor(current: TimelineItem): ContextualizedTocEntry | undefined {
276
+ const link = this.linkFor(current);
277
+ if (!link) return undefined;
278
+
279
+ const direct = this.findTocEntryByLink(this.contextualizedToc, link);
280
+ if (direct) return direct;
281
+
282
+ return this.nearestTocEntryForResource(link.href, current);
283
+ }
284
+
172
285
  private get flat(): TimelineItem[] {
173
286
  if (!this._flat) this._flat = this.flattenItems(this.items);
174
287
  return this._flat;
175
288
  }
176
289
 
290
+ /** All items flattened from _allItems, depth-independent — used by augment(). */
291
+ private get flatAll(): TimelineItem[] {
292
+ return this.flattenItems(this._allItems);
293
+ }
294
+
177
295
  // -------------------------------------------------------------------------
178
296
  // TOC title resolution
179
297
  // -------------------------------------------------------------------------
@@ -214,8 +332,17 @@ export class Timeline {
214
332
  const result: TimelineItem[] = [];
215
333
 
216
334
  for (const link of tocLinks) {
217
- if (Timeline.bareHref(link.href) === bare && link.title && !Timeline.isStartOfResource(link.href)) {
218
- const child: TimelineItem = { title: link.title, references: [link.href] };
335
+ const linkBare = Timeline.bareHref(link.href);
336
+ // Fragment-only hrefs (e.g. "#t=60" in single-track audio) have no bare href,
337
+ // so they are associated with the current resource.
338
+ const matchesBare = linkBare === bare || linkBare === '';
339
+ if (matchesBare && link.title && !Timeline.isStartOfResource(link.href)) {
340
+ // Prepend the resource href when the link uses a fragment-only reference.
341
+ const ref = linkBare === '' ? bare + link.href : link.href;
342
+ const child: TimelineItem = {
343
+ title: link.title,
344
+ references: [ref],
345
+ };
219
346
  linkMap.set(child, link);
220
347
  result.push(child);
221
348
  }
@@ -249,7 +376,8 @@ export class Timeline {
249
376
  const fragments: Link[] = [];
250
377
 
251
378
  for (const link of tocLinks) {
252
- if (Timeline.bareHref(link.href) === bare && link.title) {
379
+ const linkBare = Timeline.bareHref(link.href);
380
+ if ((linkBare === bare || linkBare === '') && link.title) {
253
381
  if (Timeline.isStartOfResource(link.href)) {
254
382
  atStart.push(link);
255
383
  } else {
@@ -271,15 +399,96 @@ export class Timeline {
271
399
 
272
400
  /**
273
401
  * A TOC href points to the start of its resource when it has no fragment,
274
- * or when the fragment contains a parsable `t=` value of 0 (audio: explicit
275
- * beginning of the file). Accepts decimals and extra params, e.g. `t=0.0`
276
- * or `foo=bar&t=0`.
402
+ * or when the fragment contains a parsable NPT `t=` value of 0 (audio:
403
+ * explicit beginning of the file).
277
404
  */
278
405
  private static isStartOfResource(href: string): boolean {
279
406
  const fragment = href.split("#")[1];
280
407
  if (!fragment) return true;
281
- const match = fragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
282
- return match !== null && parseFloat(match[1]) === 0;
408
+ const match = fragment.match(/(?:^|&)t=([^&]+)/);
409
+ return match !== null && isNptStartOfResource(match[1]);
410
+ }
411
+
412
+ // -------------------------------------------------------------------------
413
+ // Contextualized TOC
414
+ // -------------------------------------------------------------------------
415
+
416
+ private get linkToItem(): Map<Link, TimelineItem> {
417
+ if (!this._linkToItem) {
418
+ this._linkToItem = new Map();
419
+ for (const [item, link] of this.linkMap) this._linkToItem.set(link, item);
420
+ }
421
+ return this._linkToItem;
422
+ }
423
+
424
+ private buildTocEntries(links: Link[], maxDepth: number | undefined, currentDepth: number): ContextualizedTocEntry[] {
425
+ if (maxDepth !== undefined && currentDepth > maxDepth) return [];
426
+ return links.map(link => {
427
+ const item = this.linkToItem.get(link) ?? this.resourceStartItem(link.href);
428
+ const kids = link.children?.items?.length
429
+ ? this.buildTocEntries(link.children.items, maxDepth, currentDepth + 1)
430
+ : [];
431
+ return { ...this.entryFor(link, item), children: kids.length > 0 ? kids : undefined };
432
+ });
433
+ }
434
+
435
+ /** All toc Links flattened, respecting the same depth limit as `buildTocEntries`. */
436
+ private tocLinksFlat(links: Link[], maxDepth: number | undefined, currentDepth: number): Link[] {
437
+ if (maxDepth !== undefined && currentDepth > maxDepth) return [];
438
+ const result: Link[] = [];
439
+ for (const link of links) {
440
+ result.push(link);
441
+ if (link.children?.items?.length) {
442
+ result.push(...this.tocLinksFlat(link.children.items, maxDepth, currentDepth + 1));
443
+ }
444
+ }
445
+ return result;
446
+ }
447
+
448
+ private entryFor(link: Link, item: TimelineItem | undefined): ContextualizedTocEntry {
449
+ const isAudio = this._conformsTo.includes(Profile.AUDIOBOOK);
450
+ return {
451
+ link,
452
+ position: !isAudio && item?.position !== undefined ? String(item.position) : undefined,
453
+ timestamp: isAudio && item?.position !== undefined ? formatNptTime(item.position) : undefined,
454
+ };
455
+ }
456
+
457
+ private resourceStartItem(href: string): TimelineItem | undefined {
458
+ const bare = Timeline.bareHref(href);
459
+ return this._allItems.find(i => this.itemMatchesHref(i, bare));
460
+ }
461
+
462
+ private findTocEntryByLink(entries: ContextualizedTocEntry[], link: Link): ContextualizedTocEntry | undefined {
463
+ for (const entry of entries) {
464
+ if (entry.link === link) return entry;
465
+ if (entry.children) {
466
+ const found = this.findTocEntryByLink(entry.children, link);
467
+ if (found) return found;
468
+ }
469
+ }
470
+ return undefined;
471
+ }
472
+
473
+ private nearestTocEntryForResource(href: string, current: TimelineItem): ContextualizedTocEntry | undefined {
474
+ const bare = Timeline.bareHref(href);
475
+ // Re-walk with raw items (not the display-formatted TocEntry tree) so we can compare
476
+ // current.position/current.scroll directly against each candidate's source TimelineItem.
477
+ const candidates = this.tocLinksFlat(this.tocLinks, this._tocDepth, 1)
478
+ .filter(link => Timeline.bareHref(link.href) === bare)
479
+ .map(link => ({ link, item: this.linkToItem.get(link) ?? this.resourceStartItem(link.href) }));
480
+ if (candidates.length === 0) return undefined;
481
+
482
+ const isAudio = this._conformsTo.includes(Profile.AUDIOBOOK);
483
+ const currentValue = isAudio ? (current.position ?? 0) : (current.scroll ?? 0);
484
+ let best: { link: Link; item: TimelineItem | undefined } | undefined;
485
+ let bestValue = -Infinity;
486
+ for (const c of candidates) {
487
+ const v = isAudio ? (c.item?.position ?? 0) : (c.item?.scroll ?? 0);
488
+ if (v <= currentValue && v > bestValue) { bestValue = v; best = c; }
489
+ }
490
+ const chosen = best ?? candidates[0];
491
+ return this.findTocEntryByLink(this.contextualizedToc, chosen.link);
283
492
  }
284
493
 
285
494
  // -------------------------------------------------------------------------
@@ -319,26 +528,22 @@ export class Timeline {
319
528
  const hashIndex = ref.indexOf("#");
320
529
  const refHref = hashIndex >= 0 ? ref.slice(0, hashIndex) : ref;
321
530
  const refFragment = hashIndex >= 0 ? ref.slice(hashIndex + 1) : undefined;
322
- const effectiveHref = refHref || this.bareHrefFromItem(item);
531
+ // Fragment-only reference (e.g. "#t=60") has no resource of its own — use the queried href.
532
+ const effectiveHref = refHref || href;
323
533
  if (effectiveHref !== href) continue;
324
534
  if (!refFragment) return undefined;
325
- const match = refFragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
326
- return match ? parseFloat(match[1]) : undefined;
535
+ const match = refFragment.match(/(?:^|&)t=([^&]+)/);
536
+ return match ? parseNptTime(match[1]) : undefined;
327
537
  }
328
538
  return undefined;
329
539
  }
330
540
 
331
- private bareHrefFromItem(item: TimelineItem): string {
332
- return (item.references[0] ?? "").split("#")[0];
333
- }
334
-
335
- private timeFromItem(item: TimelineItem): number | undefined {
336
- const ref = item.references[0];
337
- if (!ref) return undefined;
338
- const fragment = ref.split("#")[1];
339
- if (!fragment) return undefined;
340
- const match = fragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
341
- return match ? parseFloat(match[1]) : undefined;
541
+ private itemMatchesHref(item: TimelineItem, href: string): boolean {
542
+ return item.references.some(ref => {
543
+ const bare = ref.split("#")[0];
544
+ // Fragment-only reference (single-track audio) matches the current resource.
545
+ return bare === href || bare === '';
546
+ });
342
547
  }
343
548
 
344
549
  private ancestorPath(items: TimelineItem[], target: TimelineItem): TimelineItem[] | null {
@@ -352,6 +557,10 @@ export class Timeline {
352
557
  return null;
353
558
  }
354
559
 
560
+ private itemScrollPosition(item: TimelineItem): number | undefined {
561
+ return item.scroll;
562
+ }
563
+
355
564
  private static bareHref(href: string): string {
356
565
  return href.split("#")[0];
357
566
  }
@@ -6,8 +6,8 @@
6
6
  * show previous/next as chapter titles, group search results by chapter, etc.
7
7
  */
8
8
  export interface TimelineItem {
9
- /** Display title of this entry. */
10
- title: string;
9
+ /** Display title of this entry, when one could be derived. */
10
+ title?: string;
11
11
  /**
12
12
  * References as hrefs with optional fragments.
13
13
  * e.g. ["track1.mp3#t=60"] for audio, ["chapter1.html"] for EPUB, ["#page=6"] for PDF.
@@ -15,7 +15,7 @@ export interface TimelineItem {
15
15
  references: string[];
16
16
  /** Structural roles of this entry, e.g. ["chapter"], ["part"]. */
17
17
  role?: string[];
18
- /** Position number in the reading order context. */
18
+ /** Raw position: book-global seconds for audio, a Positions List position for EPUB, a page number for PDF. */
19
19
  position?: number;
20
20
  /** Scroll progression within the resource (0 to 1), for entries that start mid-way in a resource. */
21
21
  scroll?: number;