@readium/shared 2.2.0-beta.3 → 2.2.1

package/src/publication/services/content/iterators/PublicationContentIterator.ts

@@ -1,8 +1,8 @@
-import { Resource } from "../../../../fetcher/Resource";
-import { Locator } from "../../../Locator";
-import { Publication } from "../../../Publication";
-import { IllegalStateError, Iterator } from "../Iterator";
-import { ContentElement } from "../element";
+import { Resource } from "../../../../fetcher/Resource.ts";
+import { Locator } from "../../../Locator.ts";
+import { Publication } from "../../../Publication.ts";
+import { IllegalStateError, Iterator } from "../Iterator.ts";
+import { ContentElement } from "../element/index.ts";
 
 // Creates a [Content.Iterator] instance for the [Resource], starting from the given [Locator].
 // Returns null if the resource media type is not supported.
@@ -136,9 +136,9 @@ export class PublicationContentIterator extends Iterator {
 
         for (const factory of this.resourceContentIteratorFactories) {
             const res = factory(resource, locator);
-            if(res) new IndexedIterator(index, res);
+            if(res) return new IndexedIterator(index, res);
         }
 
         return null;
     }
-}
+}

package/src/publication/services/content/iterators/helpers.ts

@@ -1,4 +1,4 @@
-import { LocatorText } from "../../../Locator";
+import { LocatorText } from "../../../Locator.ts";
 
 
 // https://github.com/jhy/jsoup/blob/0b10d516ed8f907f8fb4acb9a0806137a8988d45/src/main/java/org/jsoup/parser/Tag.java#L243

package/src/publication/services/content/iterators/index.ts

@@ -1,3 +1,3 @@
-export * from './PublicationContentIterator';
-export * from './PDFTextContentIterator';
-export * from './HTMLResourceContentIterator';
+export * from './PublicationContentIterator.ts';
+export * from './PDFTextContentIterator.ts';
+export * from './HTMLResourceContentIterator.ts';

package/src/publication/services/index.ts

@@ -1,2 +1,2 @@
-export * from './content';
-export * from './timeline';
+export * from './timeline/index.ts';
+export * from './content/index.ts';

package/src/publication/services/timeline/Timeline.ts

@@ -1,6 +1,6 @@
-import { Link, Links } from "../../Link";
-import { Locator } from "../../Locator";
-import { TimelineItem } from "./TimelineItem";
+import { Link, Links } from "../../Link.ts";
+import { Locator } from "../../Locator.ts";
+import { TimelineItem } from "./TimelineItem.ts";
 
 interface PublicationLike {
     toc?: Links;
@@ -30,6 +30,8 @@ export class Timeline {
     private _depth: number | undefined;
     private _items: TimelineItem[] | undefined;
     private _flat: TimelineItem[] | undefined;
+    /** Populated when depth is set; maps cloned items from trimToDepth back to their Links. */
+    private _trimmedLinkMap: Map<TimelineItem, Link> = new Map();
 
     constructor(items: TimelineItem[], linkMap: Map<TimelineItem, Link>) {
         this._allItems = items;
@@ -86,9 +88,12 @@ export class Timeline {
     /** Top-level timeline items.  Cached; invalidated when `depth` changes. */
     get items(): TimelineItem[] {
         if (!this._items) {
-            this._items = this._depth !== undefined
-                ? Timeline.trimToDepth(this._allItems, this._depth)
-                : this._allItems;
+            if (this._depth !== undefined) {
+                this._trimmedLinkMap = new Map();
+                this._items = Timeline.trimToDepth(this._allItems, this._depth, this.linkMap, this._trimmedLinkMap);
+            } else {
+                this._items = this._allItems;
+            }
         }
         return this._items;
     }
@@ -100,8 +105,13 @@ export class Timeline {
         let match: TimelineItem | undefined;
 
         if (time !== undefined) {
+            let bestTime = -Infinity;
             for (const item of this.flat) {
-                if (this.itemMatchesTime(item, href, time)) match = item;
+                const t = this.itemStartTime(item, href);
+                if (t !== undefined && t <= time && t > bestTime) {
+                    bestTime = t;
+                    match = item;
+                }
             }
         }
 
@@ -136,10 +146,13 @@ export class Timeline {
         if (duration !== undefined) {
             const time = progression * duration;
             let match: TimelineItem = item;
+            let bestTime = -Infinity;
             for (const child of item.children) {
                 const t = this.timeFromItem(child);
-                if (t === undefined || t > time) break;
-                match = child;
+                if (t !== undefined && t <= time && t > bestTime) {
+                    bestTime = t;
+                    match = child;
+                }
             }
             return match;
         }
@@ -153,7 +166,7 @@ export class Timeline {
     }
 
     linkFor(item: TimelineItem): Link | undefined {
-        return this.linkMap.get(item);
+        return this.linkMap.get(item) ?? this._trimmedLinkMap.get(item);
     }
 
     private get flat(): TimelineItem[] {
@@ -258,25 +271,38 @@ export class Timeline {
 
     /**
      * A TOC href points to the start of its resource when it has no fragment,
-     * or when the fragment is `t=0` (audio: explicit beginning of the file).
+     * or when the fragment contains a parsable `t=` value of 0 (audio: explicit
+     * beginning of the file).  Accepts decimals and extra params, e.g. `t=0.0`
+     * or `foo=bar&t=0`.
      */
     private static isStartOfResource(href: string): boolean {
         const fragment = href.split("#")[1];
         if (!fragment) return true;
-        return fragment === "t=0";
+        const match = fragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
+        return match !== null && parseFloat(match[1]) === 0;
     }
 
     // -------------------------------------------------------------------------
     // Shared utilities
     // -------------------------------------------------------------------------
 
-    private static trimToDepth(items: TimelineItem[], remaining: number): TimelineItem[] {
-        return items.map(item => ({
-            ...item,
-            children: remaining > 1 && item.children?.length
-                ? Timeline.trimToDepth(item.children, remaining - 1)
-                : undefined,
-        }));
+    private static trimToDepth(
+        items: TimelineItem[],
+        remaining: number,
+        sourceMap: Map<TimelineItem, Link>,
+        targetMap: Map<TimelineItem, Link>,
+    ): TimelineItem[] {
+        return items.map(item => {
+            const clone: TimelineItem = {
+                ...item,
+                children: remaining > 1 && item.children?.length
+                    ? Timeline.trimToDepth(item.children, remaining - 1, sourceMap, targetMap)
+                    : undefined,
+            };
+            const link = sourceMap.get(item);
+            if (link) targetMap.set(clone, link);
+            return clone;
+        });
     }
 
     private flattenItems(items: TimelineItem[]): TimelineItem[] {
@@ -288,21 +314,18 @@ export class Timeline {
         return result;
     }
 
-    private itemMatchesTime(item: TimelineItem, href: string, time: number): boolean {
+    private itemStartTime(item: TimelineItem, href: string): number | undefined {
         for (const ref of item.references) {
             const hashIndex = ref.indexOf("#");
             const refHref = hashIndex >= 0 ? ref.slice(0, hashIndex) : ref;
             const refFragment = hashIndex >= 0 ? ref.slice(hashIndex + 1) : undefined;
-            if ((refHref || href) !== href) continue;
-            if (time >= Timeline.parseTimeFragment(refFragment)) return true;
+            const effectiveHref = refHref || this.bareHrefFromItem(item);
+            if (effectiveHref !== href) continue;
+            if (!refFragment) return undefined;
+            const match = refFragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
+            return match ? parseFloat(match[1]) : undefined;
         }
-        return false;
-    }
-
-    private static parseTimeFragment(fragment: string | undefined): number {
-        if (!fragment) return 0;
-        const match = fragment.match(/(?:^|&)t=(\d+(?:\.\d+)?)/);
-        return match ? parseFloat(match[1]) : 0;
+        return undefined;
     }
 
     private bareHrefFromItem(item: TimelineItem): string {

package/src/publication/services/timeline/index.ts

@@ -1,2 +1,2 @@
-export * from './Timeline';
-export * from './TimelineItem';
+export * from './Timeline.ts';
+export * from './TimelineItem.ts';

package/src/util/index.ts

@@ -1,5 +1,5 @@
-export * from './mediatype';
-export * from './JSONParse';
-export * from './URITemplate';
-export * from './Language';
-export * from './tokenizer';
+export * from './mediatype/index.ts';
+export * from './JSONParse.ts';
+export * from './URITemplate.ts';
+export * from './Language.ts';
+export * from './tokenizer/index.ts';

package/src/util/mediatype/index.ts

@@ -1 +1 @@
-export * from './MediaType';
+export * from './MediaType.ts';

package/src/util/tokenizer/TextTokenizer.ts

@@ -1,7 +1,7 @@
-import { Language } from "../Language";
-import { Tokenizer } from "./Tokenizer";
-import BasicEnglishTokenizer from "./tokenize-english";
-import BasicTokenizer, { TextlintSegment } from "./tokenize-text";
+import { Language } from "../Language.ts";
+import { Tokenizer } from "./Tokenizer.ts";
+import BasicEnglishTokenizer from "./tokenize-english/index.js";
+import BasicTokenizer, { TextlintSegment } from "./tokenize-text/index.js";
 
 // Start / End
 export type Range = [number, number];
@@ -123,4 +123,4 @@ export const speakableToken = (token: string): string | null => {
     if(trimmedToken.length === 0) return null;
     if(trimmedToken.match(trimmedMatcher) === null) return null;
     return trimmedToken;
-}
+}

package/src/util/tokenizer/index.ts

@@ -1,2 +1,2 @@
-export * from './Tokenizer';
-export * from './TextTokenizer';
+export * from './Tokenizer.ts';
+export * from './TextTokenizer.ts';

package/types/src/fetcher/Fetcher.d.ts

@@ -1,5 +1,5 @@
-import { Link } from '../publication/Link';
-import { Resource } from './Resource';
+import { Link } from '../publication/Link.ts';
+import { Resource } from './Resource.ts';
 /** Provides access to a [Resource] from a [Link]. */
 export interface Fetcher {
     /**

package/types/src/fetcher/HttpFetcher.d.ts

@@ -1,6 +1,6 @@
-import { Link } from '../publication/Link';
-import { Fetcher } from './Fetcher';
-import { NumberRange, Resource } from './Resource';
+import { Link } from '../publication/Link.ts';
+import { Fetcher } from './Fetcher.ts';
+import { NumberRange, Resource } from './Resource.ts';
 export type FetchImplementation = (input: RequestInfo | URL, init?: RequestInit | undefined) => Promise<Response>;
 export declare class HttpFetcher implements Fetcher {
     private readonly baseUrl?;

package/types/src/fetcher/Resource.d.ts

@@ -1,4 +1,4 @@
-import { Link } from '../publication/Link';
+import { Link } from '../publication/Link.ts';
 export declare class NumberRange {
     readonly start: number;
     readonly endInclusive: number;

package/types/src/fetcher/index.d.ts

@@ -1,3 +1,3 @@
-export * from './Fetcher';
-export * from './HttpFetcher';
-export * from './Resource';
+export * from './Fetcher.ts';
+export * from './HttpFetcher.ts';
+export * from './Resource.ts';

package/types/src/index.d.ts

@@ -1,4 +1,4 @@
-export * from './fetcher';
-export * from './publication';
-export * from './opds';
-export * from './util';
+export * from './fetcher/index.ts';
+export * from './publication/index.ts';
+export * from './opds/index.ts';
+export * from './util/index.ts';

package/types/src/opds/index.d.ts

@@ -1,5 +1,5 @@
-export * from './Price';
-export * from './Acquisition';
-export * from './Holds';
-export * from './Copies';
-export * from './Availability';
+export * from './Price.ts';
+export * from './Acquisition.ts';
+export * from './Holds.ts';
+export * from './Copies.ts';
+export * from './Availability.ts';

package/types/src/publication/BelongsTo.d.ts

@@ -1,4 +1,4 @@
-import { Contributors as Collection } from './Contributor';
+import { Contributors as Collection } from './Contributor.ts';
 /**
  * BelongsTo Object for the Readium Web Publication Manifest.
  * https://readium.org/webpub-manifest/schema/contributor-object.schema.json

package/types/src/publication/Contributor.d.ts

@@ -1,6 +1,6 @@
-import { Links } from './Link';
-import { LocalizedString } from './LocalizedString';
-import { AltIdentifier } from './AltIdentifier';
+import { Links } from './Link.ts';
+import { LocalizedString } from './LocalizedString.ts';
+import { AltIdentifier } from './AltIdentifier.ts';
 /**
  * Contributor Object for the Readium Web Publication Manifest.
  * https://readium.org/webpub-manifest/schema/contributor-object.schema.json

package/types/src/publication/GuidedNavigation.d.ts

@@ -1,4 +1,4 @@
-import { Links } from "./Link";
+import { Links } from "./Link.ts";
 export interface Clip {
     audioResource: string;
     fragmentId?: string;

package/types/src/publication/Link.d.ts

@@ -1,6 +1,6 @@
-import { MediaType } from '../util/mediatype/MediaType';
-import { Properties } from './Properties';
-import { Locator } from './Locator';
+import { MediaType } from '../util/mediatype/MediaType.ts';
+import { Properties } from './Properties.ts';
+import { Locator } from './Locator.ts';
 /**
  * Link Object for the Readium Web Publication Manifest.
  * https://readium.org/webpub-manifest/schema/link.schema.json

package/types/src/publication/LocatorCollection.d.ts

@@ -1,6 +1,6 @@
-import { Links } from './Link';
-import { LocalizedString } from './LocalizedString';
-import { Locator } from './Locator';
+import { Links } from './Link.ts';
+import { LocalizedString } from './LocalizedString.ts';
+import { Locator } from './Locator.ts';
 /**
  * Holds the metadata of a `LocatorCollection`.
  */

package/types/src/publication/Manifest.d.ts

@@ -1,7 +1,7 @@
-import { Metadata } from './Metadata';
-import { Link, Links } from './Link';
-import { PublicationCollection } from './PublicationCollection';
-import { Locator } from "./Locator";
+import { Metadata } from './Metadata.ts';
+import { Link, Links } from './Link.ts';
+import { PublicationCollection } from './PublicationCollection.ts';
+import { Locator } from "./Locator.ts";
 /** Holds the metadata of a Readium publication, as described in
  *  the Readium Web Publication Manifest.
  *  See. https://readium.org/webpub-manifest/
@@ -9,7 +9,7 @@ import { Locator } from "./Locator";
 export declare class Manifest {
     readonly context?: Array<string>;
     readonly metadata: Metadata;
-    readonly links: Links;
+    readonly links?: Links;
     /** Identifies a list of resources in reading order for the publication. */
     readonly readingOrder: Links;
     /** Identifies resources that are necessary for rendering the publication. */
@@ -20,7 +20,7 @@ export declare class Manifest {
     constructor(values: {
         context?: Array<string>;
         metadata: Metadata;
-        links: Links;
+        links?: Links;
         readingOrder: Links;
         resources?: Links;
         toc?: Links;

package/types/src/publication/Metadata.d.ts

@@ -1,13 +1,13 @@
-import { AltIdentifier } from './AltIdentifier';
-import { BelongsTo } from './BelongsTo';
-import { Contributors } from './Contributor';
-import { Layout } from './Layout';
-import { LocalizedString } from './LocalizedString';
-import { Profile } from './Profiles';
-import { ReadingProgression } from './ReadingProgression';
-import { Subjects } from './Subject';
-import { Accessibility } from './accessibility/Accessibility';
-import { TDM } from './TDM';
+import { AltIdentifier } from './AltIdentifier.ts';
+import { BelongsTo } from './BelongsTo.ts';
+import { Contributors } from './Contributor.ts';
+import { Layout } from './Layout.ts';
+import { LocalizedString } from './LocalizedString.ts';
+import { Profile } from './Profiles.ts';
+import { ReadingProgression } from './ReadingProgression.ts';
+import { Subjects } from './Subject.ts';
+import { Accessibility } from './accessibility/Accessibility.ts';
+import { TDM } from './TDM.ts';
 /**
  * https://readium.org/webpub-manifest/schema/metadata.schema.json
  *

package/types/src/publication/Publication.d.ts

@@ -1,12 +1,12 @@
-import { Link, Links } from './Link';
-import { Locator } from './Locator';
-import { Manifest } from './Manifest';
-import { Metadata } from './Metadata';
-import { Fetcher } from '../fetcher/Fetcher';
-import { PublicationCollection } from './PublicationCollection';
-import { Resource } from '../fetcher/Resource';
-import { GuidedNavigationDocument } from "./GuidedNavigation";
-import { Timeline } from './services/timeline/Timeline';
+import { Link, Links } from './Link.ts';
+import { Locator } from './Locator.ts';
+import { Manifest } from './Manifest.ts';
+import { Metadata } from './Metadata.ts';
+import { Fetcher } from '../fetcher/Fetcher.ts';
+import { PublicationCollection } from './PublicationCollection.ts';
+import { Resource } from '../fetcher/Resource.ts';
+import { GuidedNavigationDocument } from "./GuidedNavigation.ts";
+import { Timeline } from './services/timeline/Timeline.ts';
 export type ServiceFactory = () => null;
 /** Shared model for a Readium Publication. */
 export declare class Publication {
@@ -16,7 +16,7 @@ export declare class Publication {
     private _timeline;
     readonly context?: Array<string>;
     readonly metadata: Metadata;
-    readonly links: Links;
+    readonly links?: Links;
     /** Identifies a list of resources in reading order for the publication. */
     readonly readingOrder: Links;
     /** Identifies resources that are necessary for rendering the publication. */
@@ -31,8 +31,7 @@ export declare class Publication {
     });
     /**
      * Returns the publication's timeline, built from its reading order and table of contents.
-     * Called with no arguments, the result is cached. Pass options to build a fresh timeline
-     * with a specific configuration (e.g. a depth limit).
+     * The result is cached after the first call.
      */
     get timeline(): Timeline;
     /** The URL where this publication is served, computed from the `Link` with `self` relation.
@@ -55,7 +54,7 @@ export declare class Publication {
     /**
      * Gets the cover image for the publication.
      * First looks for rel='cover' in links/resources/readingOrder,
-     * then falls back to any image (JPEG, PNG, GIF, AVIF, SVG) as bitmap fallback.
+     * then falls back to any image (JPEG, PNG, GIF, AVIF, SVG).
      */
     getCover(): Link | undefined;
     positionsFromManifest(): Promise<Locator[]>;

package/types/src/publication/PublicationCollection.d.ts

@@ -1,4 +1,4 @@
-import { Links } from './Link';
+import { Links } from './Link.ts';
 /**
  * Core Collection Model
  *

package/types/src/publication/ReadingProgression.d.ts

@@ -1,4 +1,4 @@
-import { Page } from "./Properties";
+import { Page } from "./Properties.ts";
 export declare enum ReadingProgression {
     ltr = "ltr",
     rtl = "rtl"

package/types/src/publication/Subject.d.ts

@@ -1,5 +1,5 @@
-import { Links } from './Link';
-import { LocalizedString } from './LocalizedString';
+import { Links } from './Link.ts';
+import { LocalizedString } from './LocalizedString.ts';
 /**
  * https://github.com/readium/webpub-manifest/tree/master/contexts/default#subjects
  */

package/types/src/publication/accessibility/AccessibilityMetadataDisplayGuide.d.ts

@@ -1,5 +1,5 @@
-import { Publication } from '../Publication';
-import { AccessibilityProfile } from './Accessibility';
+import { Publication } from '../Publication.ts';
+import { AccessibilityProfile } from './Accessibility.ts';
 /**
  * Represents a single accessibility claim
  */

package/types/src/publication/accessibility/index.d.ts

@@ -1,3 +1,3 @@
-export * from './Accessibility';
-export * from './AccessibilityMetadataDisplayGuide';
-export * from './Localization';
+export * from './Accessibility.ts';
+export * from './AccessibilityMetadataDisplayGuide.ts';
+export * from './Localization.ts';

package/types/src/publication/encryption/Properties.d.ts

@@ -1,4 +1,4 @@
-import { Encryption } from './Encryption';
+import { Encryption } from './Encryption.ts';
 declare module '../Properties' {
     interface Properties {
         /**

package/types/src/publication/encryption/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Encryption';
-export * from './Properties';
+export * from './Encryption.ts';
+export * from './Properties.ts';

package/types/src/publication/epub/Metadata.d.ts

@@ -1,4 +1,4 @@
-import { MediaOverlay } from "./MediaOverlay";
+import { MediaOverlay } from "./MediaOverlay.ts";
 declare module '../Metadata' {
     interface Metadata {
         getMediaOverlay(): MediaOverlay | undefined;

package/types/src/publication/epub/Publication.d.ts

@@ -1,4 +1,4 @@
-import { Links } from '../Link';
+import { Links } from '../Link.ts';
 declare module '../Publication' {
     interface Publication {
         /**

package/types/src/publication/epub/index.d.ts

@@ -1,4 +1,4 @@
-export * from './MediaOverlay';
-export * from './Metadata';
-export * from './Properties';
-export * from './Publication';
+export * from './MediaOverlay.ts';
+export * from './Metadata.ts';
+export * from './Properties.ts';
+export * from './Publication.ts';

package/types/src/publication/html/DomRange.d.ts

@@ -1,4 +1,4 @@
-import { DomRangePoint } from './DomRangePoint';
+import { DomRangePoint } from './DomRangePoint.ts';
 /**
  * This construct enables a serializable representation of a DOM Range.
  *

package/types/src/publication/html/Locations.d.ts

@@ -1,4 +1,4 @@
-import { DomRange } from './DomRange';
+import { DomRange } from './DomRange.ts';
 declare module '../Locator' {
     interface LocatorLocations {
         /**

package/types/src/publication/html/index.d.ts

@@ -1,3 +1,3 @@
-export * from './DomRange';
-export * from './DomRangePoint';
-export * from './Locations';
+export * from './DomRange.ts';
+export * from './DomRangePoint.ts';
+export * from './Locations.ts';

package/types/src/publication/index.d.ts

@@ -1,24 +1,24 @@
-export * from './accessibility';
-export * from './encryption';
-export * from './epub';
-export * from './html';
-export * from './opds';
-export * from './services';
-export * from './AltIdentifier';
-export * from './BelongsTo';
-export * from './Contributor';
-export * from './Link';
-export * from './LocalizedString';
-export * from './Locator';
-export * from './LocatorCollection';
-export * from './Manifest';
-export * from './Metadata';
-export * from './Profiles';
-export * from './Properties';
-export * from './Publication';
-export * from './PublicationCollection';
-export * from './Layout';
-export * from './ReadingProgression';
-export * from './Subject';
-export * from './TDM';
-export * from './GuidedNavigation';
+export * from './accessibility/index.ts';
+export * from './encryption/index.ts';
+export * from './epub/index.ts';
+export * from './html/index.ts';
+export * from './opds/index.ts';
+export * from './services/index.ts';
+export * from './AltIdentifier.ts';
+export * from './BelongsTo.ts';
+export * from './Contributor.ts';
+export * from './Link.ts';
+export * from './LocalizedString.ts';
+export * from './Locator.ts';
+export * from './LocatorCollection.ts';
+export * from './Manifest.ts';
+export * from './Metadata.ts';
+export * from './Profiles.ts';
+export * from './Properties.ts';
+export * from './Publication.ts';
+export * from './PublicationCollection.ts';
+export * from './Layout.ts';
+export * from './ReadingProgression.ts';
+export * from './Subject.ts';
+export * from './TDM.ts';
+export * from './GuidedNavigation.ts';

package/types/src/publication/opds/Properties.d.ts

@@ -1,5 +1,5 @@
-import { Copies, Acquisition, Holds, Price, Availability } from '../../opds';
-import { Link } from '../Link';
+import { Copies, Acquisition, Holds, Price, Availability } from '../../opds/index.ts';
+import { Link } from '../Link.ts';
 declare module '../Properties' {
     interface Properties {
         /**

package/types/src/publication/opds/Publication.d.ts

@@ -1,4 +1,4 @@
-import { Links } from '../Link';
+import { Links } from '../Link.ts';
 declare module '../Publication' {
     interface Publication {
         getImages(): Links | undefined;

package/types/src/publication/opds/index.d.ts

@@ -1,2 +1,2 @@
-export * from './Properties';
-export * from './Publication';
+export * from './Properties.ts';
+export * from './Publication.ts';