@readium/shared 2.4.0-alpha.1 → 2.5.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 (166) 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 -4993
  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 +29 -19
  106. package/src/fetcher/HttpFetcher.ts +5 -5
  107. package/src/fetcher/Resource.ts +5 -10
  108. package/src/locales/publication-metadata/ar.json +402 -0
  109. package/src/locales/publication-metadata/brh.json +1 -0
  110. package/src/locales/publication-metadata/da.json +310 -0
  111. package/src/locales/publication-metadata/el.json +310 -0
  112. package/src/locales/publication-metadata/en.json +310 -0
  113. package/src/locales/publication-metadata/es.json +333 -0
  114. package/src/locales/publication-metadata/et.json +310 -0
  115. package/src/locales/publication-metadata/fi.json +310 -0
  116. package/src/locales/publication-metadata/fr.json +333 -0
  117. package/src/locales/publication-metadata/he.json +9 -0
  118. package/src/locales/publication-metadata/it.json +333 -0
  119. package/src/locales/publication-metadata/lt.json +8 -0
  120. package/src/locales/publication-metadata/pl.json +333 -0
  121. package/src/locales/publication-metadata/pt_PT.json +329 -0
  122. package/src/locales/publication-metadata/sv.json +310 -0
  123. package/src/locales/publication-metadata/tr.json +51 -0
  124. package/src/locales/publication-metadata/uk.json +1 -0
  125. package/src/publication/Link.ts +2 -6
  126. package/src/publication/Locator.ts +21 -3
  127. package/src/publication/Manifest.ts +10 -10
  128. package/src/publication/Publication.ts +2 -1
  129. package/src/publication/accessibility/Localization.ts +12 -14
  130. package/src/publication/accessibility/SupportedLanguages.ts +1 -1
  131. package/src/publication/encryption/Properties.ts +3 -15
  132. package/src/publication/epub/Metadata.ts +6 -12
  133. package/src/publication/epub/Properties.ts +3 -13
  134. package/src/publication/epub/Publication.ts +18 -39
  135. package/src/publication/html/Locations.ts +63 -99
  136. package/src/publication/opds/Properties.ts +21 -66
  137. package/src/publication/opds/Publication.ts +3 -9
  138. package/src/publication/services/content/iterators/HTMLResourceContentIterator.ts +3 -1
  139. package/src/publication/services/timeline/Timeline.ts +311 -60
  140. package/src/publication/services/timeline/TimelineItem.ts +3 -3
  141. package/src/publication/services/timeline/audio.ts +31 -0
  142. package/src/publication/services/timeline/html.ts +5 -0
  143. package/src/publication/services/timeline/index.ts +12 -0
  144. package/src/util/npt.ts +19 -0
  145. package/types/src/fetcher/HttpFetcher.d.ts +3 -3
  146. package/types/src/fetcher/Resource.d.ts +2 -6
  147. package/types/src/publication/encryption/Properties.d.ts +2 -9
  148. package/types/src/publication/epub/Metadata.d.ts +3 -6
  149. package/types/src/publication/epub/Properties.d.ts +2 -10
  150. package/types/src/publication/epub/Publication.d.ts +7 -18
  151. package/types/src/publication/html/Locations.d.ts +17 -44
  152. package/types/src/publication/opds/Properties.d.ts +8 -36
  153. package/types/src/publication/opds/Publication.d.ts +2 -5
  154. package/types/src/publication/services/timeline/Timeline.d.ts +93 -13
  155. package/types/src/publication/services/timeline/TimelineItem.d.ts +3 -3
  156. package/types/src/publication/services/timeline/audio.d.ts +4 -0
  157. package/types/src/publication/services/timeline/html.d.ts +4 -0
  158. package/types/src/publication/services/timeline/index.d.ts +6 -0
  159. package/types/src/util/npt.d.ts +10 -0
  160. package/dist/ar-DyHX_uy2.js +0 -7
  161. package/dist/da-Dct0PS3E.js +0 -7
  162. package/dist/fr-C5HEel98.js +0 -7
  163. package/dist/index.umd.cjs +0 -3
  164. package/dist/it-DFOBoXGy.js +0 -7
  165. package/dist/pt_PT-Di3sVjze.js +0 -7
  166. 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].
6
+ // OPDS extensions for link Properties.
7
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://specs.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,11 +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
- import { isNptStartOfResource, parseNptTime } from "../../../util/npt.ts";
5
7
 
6
- interface PublicationLike {
8
+ export interface PublicationLike {
7
9
  toc?: Links;
8
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[];
9
29
  }
10
30
 
11
31
  /**
@@ -17,32 +37,61 @@ interface PublicationLike {
17
37
  * 2. Populate flat children — all TOC fragment entries that reference the
18
38
  * resource, collected depth-first in TOC declaration order.
19
39
  *
20
- * No TOC hierarchy is reconstructed; that requires role context and is not yet
21
- * implemented. TOC entries whose href does not match any reading order item
22
- * 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.
23
45
  *
24
- * The `depth` build option limits how many levels deep into the TOC tree both
25
- * title resolution and child collection may look. Level 1 = top-level TOC
26
- * 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.
27
50
  */
28
51
  export class Timeline {
29
52
  private readonly _allItems: TimelineItem[];
30
53
  private readonly linkMap: Map<TimelineItem, Link>;
54
+ private readonly _conformsTo: readonly Profile[];
55
+ private readonly tocLinks: Link[];
31
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;
32
66
  private _items: TimelineItem[] | undefined;
33
67
  private _flat: TimelineItem[] | undefined;
68
+ private _toc: ContextualizedTocEntry[] | undefined;
69
+ private _linkToItem: Map<Link, TimelineItem> | undefined;
34
70
  /** Populated when depth is set; maps cloned items from trimToDepth back to their Links. */
35
71
  private _trimmedLinkMap: Map<TimelineItem, Link> = new Map();
36
72
 
37
- 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
+ ) {
38
80
  this._allItems = items;
39
81
  this.linkMap = linkMap;
82
+ this._conformsTo = conformsTo;
83
+ this.tocLinks = tocLinks;
84
+ this._tocDepth = tocDepth;
40
85
  }
41
86
 
42
- static build(publication: PublicationLike, options: { depth?: number } = {}): Timeline {
87
+ static build(
88
+ publication: PublicationLike,
89
+ options: { depth?: number } = {},
90
+ ): Timeline {
43
91
  const tocLinks = publication.toc?.items ?? [];
44
92
  const roLinks = publication.readingOrder.items;
45
93
  const { depth } = options;
94
+ const conformsTo = publication.metadata?.conformsTo ?? [];
46
95
  const linkMap = new Map<TimelineItem, Link>();
47
96
  const items: TimelineItem[] = [];
48
97
 
@@ -52,8 +101,7 @@ export class Timeline {
52
101
 
53
102
  const title =
54
103
  ro.title ??
55
- Timeline.findTitleInToc(tocLinks, bare, depth) ??
56
- `Resource ${i + 1}`;
104
+ Timeline.findTitleInToc(tocLinks, bare, depth);
57
105
 
58
106
  const tocChildren = Timeline.collectChildrenFromToc(tocLinks, bare, depth, 1, linkMap);
59
107
 
@@ -67,7 +115,25 @@ export class Timeline {
67
115
  items.push(item);
68
116
  }
69
117
 
70
- 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
+ }
71
137
  }
72
138
 
73
139
  /**
@@ -82,8 +148,10 @@ export class Timeline {
82
148
  set depth(value: number | undefined) {
83
149
  if (this._depth === value) return;
84
150
  this._depth = value;
151
+ this._tocDepth = value;
85
152
  this._items = undefined;
86
153
  this._flat = undefined;
154
+ this._toc = undefined;
87
155
  }
88
156
 
89
157
  /** Top-level timeline items. Cached; invalidated when `depth` changes. */
@@ -101,29 +169,67 @@ export class Timeline {
101
169
 
102
170
  locate(locator: Locator): TimelineItem | undefined {
103
171
  const href = locator.href.split("#")[0];
104
- const time = locator.locations?.time();
105
-
106
- let match: TimelineItem | undefined;
172
+ const time = getTime(locator.locations);
173
+ const htmlId = getHtmlId(locator.locations);
174
+ const progression = locator.locations.progression;
107
175
 
176
+ // Audio: best-match on t= start time.
108
177
  if (time !== undefined) {
109
178
  let bestTime = -Infinity;
179
+ let match: TimelineItem | undefined;
110
180
  for (const item of this.flat) {
181
+ if (!this.itemMatchesHref(item, href)) continue;
111
182
  const t = this.itemStartTime(item, href);
112
183
  if (t !== undefined && t <= time && t > bestTime) {
113
184
  bestTime = t;
114
185
  match = item;
115
186
  }
116
187
  }
188
+ if (match) return match;
117
189
  }
118
190
 
119
- if (!match) {
120
- match = this.flat.find(item => this.bareHrefFromItem(item) === href);
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;
198
+ }
199
+
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
+ }
121
225
  }
122
226
 
123
- return match;
227
+ // Fallback: bare href match.
228
+ return this.flat.find(item => this.itemMatchesHref(item, href));
124
229
  }
125
230
 
126
- adjacentTo(item: TimelineItem): { previous: TimelineItem | undefined; next: TimelineItem | undefined } {
231
+ /** The items navigable to/from `item`: its previous/next neighbors in the flattened timeline. */
232
+ navigableFrom(item: TimelineItem): { previous: TimelineItem | undefined; next: TimelineItem | undefined } {
127
233
  const index = this.flat.indexOf(item);
128
234
  return {
129
235
  previous: index > 0 ? this.flat[index - 1] : undefined,
@@ -133,35 +239,11 @@ export class Timeline {
133
239
 
134
240
  segmentsForHref(href: string): TimelineItem[] {
135
241
  const bare = href.split("#")[0];
136
- const item = this.items.find(i => this.bareHrefFromItem(i) === bare);
242
+ const item = this.items.find(i => this.itemMatchesHref(i, bare));
137
243
  if (!item) return [];
138
244
  return item.children?.length ? item.children : [item];
139
245
  }
140
246
 
141
- itemAtProgression(href: string, progression: number, duration?: number): TimelineItem | undefined {
142
- const bare = href.split("#")[0];
143
- const item = this.items.find(i => this.bareHrefFromItem(i) === bare);
144
- if (!item) return undefined;
145
- if (!item.children?.length) return item;
146
-
147
- if (duration !== undefined) {
148
- const time = progression * duration;
149
- let match: TimelineItem = item;
150
- let bestTime = -Infinity;
151
- for (const child of item.children) {
152
- const t = this.timeFromItem(child);
153
- if (t !== undefined && t <= time && t > bestTime) {
154
- bestTime = t;
155
- match = child;
156
- }
157
- }
158
- return match;
159
- }
160
-
161
- const index = Math.min(Math.floor(progression * item.children.length), item.children.length - 1);
162
- return item.children[index];
163
- }
164
-
165
247
  ancestors(item: TimelineItem): TimelineItem[] {
166
248
  return this.ancestorPath(this.items, item) ?? [];
167
249
  }
@@ -170,11 +252,52 @@ export class Timeline {
170
252
  return this.linkMap.get(item) ?? this._trimmedLinkMap.get(item);
171
253
  }
172
254
 
255
+ /**
256
+ * The authored TOC, contextualized with display-ready progression. Mirrors
257
+ * `publication.toc`'s authored hierarchy (respecting `depth`), falling
258
+ * back to one flat entry per reading-order item when there's no toc at
259
+ * all. Cached; invalidated when `depth` changes.
260
+ */
261
+ get contextualizedToc(): ContextualizedTocEntry[] {
262
+ if (!this._toc) {
263
+ this._toc = this.tocLinks.length > 0
264
+ ? this.buildTocEntries(this.tocLinks, this._tocDepth, 1)
265
+ : this._allItems.map(item => this.entryFor(this.linkFor(item)!, item));
266
+ }
267
+ return this._toc;
268
+ }
269
+
270
+ /**
271
+ * Maps a `TimelineItem` (typically from `locate()`) to its `ContextualizedTocEntry`,
272
+ * trying three fallbacks in order:
273
+ * 1. A direct match on `current`'s own link.
274
+ * 2. The nearest preceding toc entry within the same resource.
275
+ * 3. When no toc entry references the resource at all, the nearest
276
+ * preceding resource's toc entry.
277
+ */
278
+ tocEntryFor(current: TimelineItem): ContextualizedTocEntry | undefined {
279
+ const link = this.linkFor(current);
280
+ if (!link) return undefined;
281
+
282
+ const direct = this.findTocEntryByLink(this.contextualizedToc, link);
283
+ if (direct) return direct;
284
+
285
+ const nearest = this.nearestTocEntryForResource(link.href, current);
286
+ if (nearest) return nearest;
287
+
288
+ return this.previousResolvedTocEntry(link);
289
+ }
290
+
173
291
  private get flat(): TimelineItem[] {
174
292
  if (!this._flat) this._flat = this.flattenItems(this.items);
175
293
  return this._flat;
176
294
  }
177
295
 
296
+ /** All items flattened from _allItems, depth-independent — used by augment(). */
297
+ private get flatAll(): TimelineItem[] {
298
+ return this.flattenItems(this._allItems);
299
+ }
300
+
178
301
  // -------------------------------------------------------------------------
179
302
  // TOC title resolution
180
303
  // -------------------------------------------------------------------------
@@ -215,8 +338,20 @@ export class Timeline {
215
338
  const result: TimelineItem[] = [];
216
339
 
217
340
  for (const link of tocLinks) {
218
- if (Timeline.bareHref(link.href) === bare && link.title && !Timeline.isStartOfResource(link.href)) {
219
- const child: TimelineItem = { title: link.title, references: [link.href] };
341
+ const linkBare = Timeline.bareHref(link.href);
342
+ // Fragment-only hrefs (e.g. "#t=60" in single-track audio) have no bare href,
343
+ // so they are associated with the current resource. A hrefless link (e.g. a
344
+ // <span> grouping heading) also bareHrefs to '', but names no resource at all
345
+ // and must not match every resource.
346
+ const isFragmentOnly = link.href.startsWith('#');
347
+ const matchesBare = linkBare === bare || (isFragmentOnly && linkBare === '');
348
+ if (matchesBare && link.title && !Timeline.isStartOfResource(link.href)) {
349
+ // Prepend the resource href when the link uses a fragment-only reference.
350
+ const ref = linkBare === '' ? bare + link.href : link.href;
351
+ const child: TimelineItem = {
352
+ title: link.title,
353
+ references: [ref],
354
+ };
220
355
  linkMap.set(child, link);
221
356
  result.push(child);
222
357
  }
@@ -250,7 +385,9 @@ export class Timeline {
250
385
  const fragments: Link[] = [];
251
386
 
252
387
  for (const link of tocLinks) {
253
- if (Timeline.bareHref(link.href) === bare && link.title) {
388
+ const linkBare = Timeline.bareHref(link.href);
389
+ const isFragmentOnly = link.href.startsWith('#');
390
+ if ((linkBare === bare || (isFragmentOnly && linkBare === '')) && link.title) {
254
391
  if (Timeline.isStartOfResource(link.href)) {
255
392
  atStart.push(link);
256
393
  } else {
@@ -282,6 +419,120 @@ export class Timeline {
282
419
  return match !== null && isNptStartOfResource(match[1]);
283
420
  }
284
421
 
422
+ // -------------------------------------------------------------------------
423
+ // Contextualized TOC
424
+ // -------------------------------------------------------------------------
425
+
426
+ private get linkToItem(): Map<Link, TimelineItem> {
427
+ if (!this._linkToItem) {
428
+ this._linkToItem = new Map();
429
+ for (const [item, link] of this.linkMap) this._linkToItem.set(link, item);
430
+ }
431
+ return this._linkToItem;
432
+ }
433
+
434
+ private buildTocEntries(links: Link[], maxDepth: number | undefined, currentDepth: number): ContextualizedTocEntry[] {
435
+ if (maxDepth !== undefined && currentDepth > maxDepth) return [];
436
+ return links.map(link => {
437
+ const item = this.linkToItem.get(link) ?? this.resourceStartItem(link.href);
438
+ const kids = link.children?.items?.length
439
+ ? this.buildTocEntries(link.children.items, maxDepth, currentDepth + 1)
440
+ : [];
441
+ return { ...this.entryFor(link, item), children: kids.length > 0 ? kids : undefined };
442
+ });
443
+ }
444
+
445
+ /** All toc Links flattened, respecting the same depth limit as `buildTocEntries`. */
446
+ private tocLinksFlat(links: Link[], maxDepth: number | undefined, currentDepth: number): Link[] {
447
+ if (maxDepth !== undefined && currentDepth > maxDepth) return [];
448
+ const result: Link[] = [];
449
+ for (const link of links) {
450
+ result.push(link);
451
+ if (link.children?.items?.length) {
452
+ result.push(...this.tocLinksFlat(link.children.items, maxDepth, currentDepth + 1));
453
+ }
454
+ }
455
+ return result;
456
+ }
457
+
458
+ private entryFor(link: Link, item: TimelineItem | undefined): ContextualizedTocEntry {
459
+ const isAudio = this._conformsTo.includes(Profile.AUDIOBOOK);
460
+ return {
461
+ link,
462
+ position: !isAudio && item?.position !== undefined ? String(item.position) : undefined,
463
+ timestamp: isAudio && item?.position !== undefined ? formatNptTime(item.position) : undefined,
464
+ };
465
+ }
466
+
467
+ private resourceStartItem(href: string): TimelineItem | undefined {
468
+ const bare = Timeline.bareHref(href);
469
+ return this._allItems.find(i => this.itemMatchesHref(i, bare));
470
+ }
471
+
472
+ private findTocEntryByLink(entries: ContextualizedTocEntry[], link: Link): ContextualizedTocEntry | undefined {
473
+ for (const entry of entries) {
474
+ if (entry.link === link) return entry;
475
+ if (entry.children) {
476
+ const found = this.findTocEntryByLink(entry.children, link);
477
+ if (found) return found;
478
+ }
479
+ }
480
+ return undefined;
481
+ }
482
+
483
+ /**
484
+ * Tier-2 fallback for `tocEntryFor`: among the toc entries that reference
485
+ * `href`'s own resource (e.g. chapter markers within one audio file),
486
+ * return the nearest one at or before `current`'s position/scroll.
487
+ */
488
+ private nearestTocEntryForResource(href: string, current: TimelineItem): ContextualizedTocEntry | undefined {
489
+ const bare = Timeline.bareHref(href);
490
+ // Re-walk with raw items (not the display-formatted TocEntry tree) so we can compare
491
+ // current.position/current.scroll directly against each candidate's source TimelineItem.
492
+ const candidates = this.tocLinksFlat(this.tocLinks, this._tocDepth, 1)
493
+ .filter(link => Timeline.bareHref(link.href) === bare)
494
+ .map(link => ({ link, item: this.linkToItem.get(link) ?? this.resourceStartItem(link.href) }));
495
+ if (candidates.length === 0) return undefined;
496
+
497
+ const isAudio = this._conformsTo.includes(Profile.AUDIOBOOK);
498
+ const currentValue = isAudio ? (current.position ?? 0) : (current.scroll ?? 0);
499
+ let best: { link: Link; item: TimelineItem | undefined } | undefined;
500
+ let bestValue = -Infinity;
501
+ for (const c of candidates) {
502
+ const v = isAudio ? (c.item?.position ?? 0) : (c.item?.scroll ?? 0);
503
+ if (v <= currentValue && v > bestValue) { bestValue = v; best = c; }
504
+ }
505
+ const chosen = best ?? candidates[0];
506
+ return this.findTocEntryByLink(this.contextualizedToc, chosen.link);
507
+ }
508
+
509
+ /**
510
+ * Tier-3 fallback for `tocEntryFor`: when no toc entry references
511
+ * `href`'s resource at all, walk backward through the reading order and
512
+ * return the nearest preceding resource's toc entry.
513
+ */
514
+ private previousResolvedTocEntry(link: Link): ContextualizedTocEntry | undefined {
515
+ const index = this._allItems.findIndex(item => this.linkFor(item) === link);
516
+ if (index === -1) return undefined;
517
+
518
+ for (let i = index - 1; i >= 0; i--) {
519
+ const precedingLink = this.linkFor(this._allItems[i]);
520
+ if (!precedingLink) continue;
521
+ const precedingBare = Timeline.bareHref(precedingLink.href);
522
+ const { atStart, fragments } = Timeline.collectTocCandidates(this.tocLinks, precedingBare, this._tocDepth, 1);
523
+ // Exclude fragment-only entries (bareHref "") — collectTocCandidates
524
+ // treats them as matching any bare href for single-track audio, but
525
+ // here they must belong to this specific preceding resource.
526
+ const ownAtStart = atStart.filter(l => Timeline.bareHref(l.href) === precedingBare);
527
+ const ownFragments = fragments.filter(l => Timeline.bareHref(l.href) === precedingBare);
528
+ const chosen = ownAtStart[0] ?? (ownFragments.length > 0 ? ownFragments[ownFragments.length - 1] : undefined);
529
+ if (!chosen) continue;
530
+ const entry = this.findTocEntryByLink(this.contextualizedToc, chosen);
531
+ if (entry) return entry;
532
+ }
533
+ return undefined;
534
+ }
535
+
285
536
  // -------------------------------------------------------------------------
286
537
  // Shared utilities
287
538
  // -------------------------------------------------------------------------
@@ -319,7 +570,8 @@ export class Timeline {
319
570
  const hashIndex = ref.indexOf("#");
320
571
  const refHref = hashIndex >= 0 ? ref.slice(0, hashIndex) : ref;
321
572
  const refFragment = hashIndex >= 0 ? ref.slice(hashIndex + 1) : undefined;
322
- const effectiveHref = refHref || this.bareHrefFromItem(item);
573
+ // Fragment-only reference (e.g. "#t=60") has no resource of its own — use the queried href.
574
+ const effectiveHref = refHref || href;
323
575
  if (effectiveHref !== href) continue;
324
576
  if (!refFragment) return undefined;
325
577
  const match = refFragment.match(/(?:^|&)t=([^&]+)/);
@@ -328,17 +580,12 @@ export class Timeline {
328
580
  return undefined;
329
581
  }
330
582
 
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=([^&]+)/);
341
- return match ? parseNptTime(match[1]) : undefined;
583
+ private itemMatchesHref(item: TimelineItem, href: string): boolean {
584
+ return item.references.some(ref => {
585
+ const bare = ref.split("#")[0];
586
+ // Fragment-only reference (single-track audio) matches the current resource.
587
+ return bare === href || bare === '';
588
+ });
342
589
  }
343
590
 
344
591
  private ancestorPath(items: TimelineItem[], target: TimelineItem): TimelineItem[] | null {
@@ -352,6 +599,10 @@ export class Timeline {
352
599
  return null;
353
600
  }
354
601
 
602
+ private itemScrollPosition(item: TimelineItem): number | undefined {
603
+ return item.scroll;
604
+ }
605
+
355
606
  private static bareHref(href: string): string {
356
607
  return href.split("#")[0];
357
608
  }