@readium/navigator 2.6.0 → 2.7.0

package/src/webpub/WebPubNavigator.ts

@@ -1,11 +1,11 @@
-import { Feature, Link, Locator, LocatorText, Publication, ReadingProgression, LocatorLocations } from "@readium/shared";
+import { Feature, Link, Locator, LocatorText, Publication, ReadingProgression, LocatorLocations, Timeline, TimelineItem, getCssSelector, getHtmlId } from "@readium/shared";
 import { VisualNavigator, VisualNavigatorViewport, ProgressionRange, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { WebPubFramePoolManager } from "./WebPubFramePoolManager.ts";
-import { BasicTextSelection, CommsEventKey, ContextMenuEvent, DecorationActivatedEvent, FrameClickEvent, KeyboardPeripheralEvent, ModuleName, SuspiciousActivityEvent, WebPubModules } from "@readium/navigator-html-injectables";
+import { BasicTextSelection, CommsEventKey, ContextMenuEvent, DecorationActivatedEvent, DecorationPointerEnterData, DecorationPointerLeaveData, FrameClickEvent, KeyboardPeripheralEvent, ModuleName, SuspiciousActivityEvent, WebPubModules } from "@readium/navigator-html-injectables";
 import * as path from "path-browserify";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
-import { Decoration, DecorableNavigator, DecorationActivationEvent, DecorationObserver, DecoratorConfig, decorationsEqual, resolveDecorationForWire, BUILTIN_DECORATION_TYPES } from "../decorations/index.ts";
+import { Decoration, DecorableNavigator, OnDecorationActivatedEvent, OnDecorationPointerEnterEvent, OnDecorationPointerLeaveEvent, DecorationObserver, DecoratorConfig, decorationsEqual, resolveDecorationForWire, supportsDecorationStyle as canRenderDecorationStyle, DecorationStyleType } from "../decorations/index.ts";
 import { ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { getScriptMode } from "../helpers/scriptMode.ts";
 import { WebPubCSS } from "./css/WebPubCSS.ts";
@@ -33,6 +33,7 @@ export interface WebPubNavigatorConfiguration {
 export interface WebPubNavigatorListeners {
     frameLoaded: (wnd: Window) => void;
     positionChanged: (locator: Locator) => void;
+    timelineItemChanged: (item: TimelineItem | undefined) => void;
     tap: (e: FrameClickEvent) => boolean;
     click: (e: FrameClickEvent) => boolean;
     zoom: (scale: number) => void;
@@ -48,6 +49,7 @@ export interface WebPubNavigatorListeners {
 const defaultListeners = (listeners: WebPubNavigatorListeners): WebPubNavigatorListeners => ({
     frameLoaded: listeners.frameLoaded || (() => {}),
     positionChanged: listeners.positionChanged || (() => {}),
+    timelineItemChanged: listeners.timelineItemChanged || (() => {}),
     tap: listeners.tap || (() => false),
     click: listeners.click || (() => false),
     zoom: listeners.zoom || (() => {}),
@@ -67,6 +69,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
     private framePool!: WebPubFramePoolManager;
     private currentIndex: number = 0;
     private currentLocation: Locator;
+    private _currentTimelineItem: TimelineItem | undefined;
 
     private _preferences: WebPubPreferences;
     private _defaults: WebPubDefaults;
@@ -86,7 +89,9 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
 
     private _decorations: Map<string, Decoration[]> = new Map();
     private _decorationObservers: Map<string, Set<DecorationObserver>> = new Map();
+    private _decorationHoveredDecorations: Map<string, Decoration> = new Map();
     private _decorationActivationState: Map<string, boolean> = new Map();
+    private _decorationHoverState: Map<string, boolean> = new Map();
     private _decorationActivationConsumed = false;
 
     private webViewport: VisualNavigatorViewport = {
@@ -184,7 +189,11 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
             cssProperties,
             this._injector,
             this._contentProtection,
-            this._keyboardPeripherals
+            this._keyboardPeripherals,
+            (href) => this.pub.timeline.segmentsForHref(href)
+                .flatMap(item => item.references)
+                .map(ref => { const h = ref.indexOf('#'); return h >= 0 ? ref.slice(h + 1) : ''; })
+                .filter(Boolean)
         );
 
         await this.apply();
@@ -264,6 +273,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
             case "_pong":
                 this.listeners.frameLoaded(this.framePool.currentFrames[0]!.iframe.contentWindow!);
                 this.listeners.positionChanged(this.currentLocation);
+                this._notifyTimelineChange(this.currentLocation);
                 this._reapplyDecorationsToCurrentFrame();
                 break;
             case "first_visible_locator":
@@ -277,6 +287,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
                     text: loc?.text
                 });
                 this.listeners.positionChanged(this.currentLocation);
+                this._notifyTimelineChange(this.currentLocation);
                 break;
             case "text_selected": {
                 const selection = data as BasicTextSelection;
@@ -289,6 +300,12 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
                 if (handled) this._decorationActivationConsumed = true;
                 break;
             }
+            case "decoration_pointer_enter":
+                this._handleDecorationPointerEnter(data as DecorationPointerEnterData);
+                break;
+            case "decoration_pointer_leave":
+                this._handleDecorationPointerLeave(data as DecorationPointerLeaveData);
+                break;
             case "click":
             case "tap":
                 if (this._decorationActivationConsumed) {
@@ -440,14 +457,15 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         await this.framePool?.destroy();
         this._decorations.clear();
         this._decorationObservers.clear();
+        this._decorationHoveredDecorations.clear();
         this._decorationActivationState.clear();
+        this._decorationHoverState.clear();
     }
 
     // DecorableNavigator
 
-    public supportsDecorationStyle(styleTypeId: string): boolean {
-        return BUILTIN_DECORATION_TYPES.has(styleTypeId) ||
-            !!this._decoratorConfig.decorationTemplates?.[styleTypeId];
+    public supportsDecorationStyle(styleTypeId: DecorationStyleType | string): boolean {
+        return canRenderDecorationStyle(styleTypeId, this._decoratorConfig.decorationTemplates);
     }
 
     public registerDecorationObserver(group: string, observer: DecorationObserver): void {
@@ -455,18 +473,32 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
             this._decorationObservers.set(group, new Set());
         this._decorationObservers.get(group)!.add(observer);
 
-        this._decorationActivationState.set(group, true);
-        this._sendDecorationActivatable(group, true);
+        if (observer.onDecorationActivated) {
+            this._decorationActivationState.set(group, true);
+            this._sendDecorationActivatable(group, true);
+        }
+
+        if (observer.onDecorationPointerEnter || observer.onDecorationPointerLeave) {
+            this._decorationHoverState.set(group, true);
+            this._sendDecorationHoverable(group, true);
+        }
     }
 
     public unregisterDecorationObserver(observer: DecorationObserver): void {
         this._decorationObservers.forEach((set, group) => {
-            if (set.has(observer)) {
-                set.delete(observer);
-                if (set.size === 0) {
-                    this._decorationActivationState.delete(group);
-                    this._sendDecorationActivatable(group, false);
-                }
+            if (!set.has(observer)) return;
+            set.delete(observer);
+
+            const stillActivatable = [...set].some(o => o.onDecorationActivated);
+            if (this._decorationActivationState.has(group) && !stillActivatable) {
+                this._decorationActivationState.delete(group);
+                this._sendDecorationActivatable(group, false);
+            }
+
+            const stillHoverable = [...set].some(o => o.onDecorationPointerEnter || o.onDecorationPointerLeave);
+            if (this._decorationHoverState.has(group) && !stillHoverable) {
+                this._decorationHoverState.delete(group);
+                this._sendDecorationHoverable(group, false);
             }
         });
     }
@@ -476,6 +508,11 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         if (frame?.msg) frame.msg.send("decoration_activatable", { group, activatable });
     }
 
+    private _sendDecorationHoverable(group: string, hoverable: boolean): void {
+        const frame = this.framePool?.currentFrames[0];
+        if (frame?.msg) frame.msg.send("decoration_hoverable", { group, hoverable });
+    }
+
     public applyDecorations(decorations: Decoration[], group: string): void {
         const previous = this._decorations.get(group) ?? [];
         const prevById = new Map(previous.map(d => [d.id, d]));
@@ -498,6 +535,8 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
 
         const activatable = this._decorationActivationState.get(group);
         if (activatable !== undefined) this._sendDecorationActivatable(group, activatable);
+        const hoverable = this._decorationHoverState.get(group);
+        if (hoverable !== undefined) this._sendDecorationHoverable(group, hoverable);
     }
 
     private _sendDecorationOps(
@@ -542,6 +581,9 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         for (const [group, activatable] of this._decorationActivationState) {
             frame.msg.send("decoration_activatable", { group, activatable });
         }
+        for (const [group, hoverable] of this._decorationHoverState) {
+            frame.msg.send("decoration_hoverable", { group, hoverable });
+        }
     }
 
     private _handleDecorationActivated(data: DecorationActivatedEvent): boolean {
@@ -551,13 +593,36 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         const decoration = (this._decorations.get(data.group) ?? []).find(d => d.id === data.decorationId);
         if (!decoration) return false;
 
-        const event: DecorationActivationEvent = { decoration, group: data.group, rect: data.rect, point: data.point };
+        const event: OnDecorationActivatedEvent = { decoration, group: data.group, rect: data.rect, point: data.point };
         let anyHandled = false;
         for (const obs of observers)
-            if (obs.onDecorationActivated(event)) anyHandled = true;
+            if (obs.onDecorationActivated?.(event)) anyHandled = true;
         return anyHandled;
     }
 
+    private _handleDecorationPointerEnter(data: DecorationPointerEnterData): void {
+        const observers = this._decorationObservers.get(data.group);
+        if (!observers || observers.size === 0) return;
+        const decoration = (this._decorations.get(data.group) ?? []).find(d => d.id === data.decorationId);
+        if (!decoration) return;
+        this._decorationHoveredDecorations.set(data.group, decoration);
+        const event: OnDecorationPointerEnterEvent = { decoration, group: data.group, rect: data.rect, point: data.point };
+        for (const obs of observers)
+            obs.onDecorationPointerEnter?.(event);
+    }
+
+    private _handleDecorationPointerLeave(data: DecorationPointerLeaveData): void {
+        const observers = this._decorationObservers.get(data.group);
+        if (!observers || observers.size === 0) return;
+        const decoration = (this._decorations.get(data.group) ?? []).find(d => d.id === data.decorationId)
+            ?? this._decorationHoveredDecorations.get(data.group);
+        this._decorationHoveredDecorations.delete(data.group);
+        if (!decoration) return;
+        const event: OnDecorationPointerLeaveEvent = { decoration, group: data.group, rect: data.rect, point: data.point };
+        for (const obs of observers)
+            obs.onDecorationPointerLeave?.(event);
+    }
+
     // End of DecorableNavigator
 
     private async changeResource(relative: number): Promise<boolean> {
@@ -604,6 +669,10 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
 
         this.updateViewport(progression);
         this.listeners.positionChanged(this.currentLocation);
+        const locatorForTimeline = progression.fragmentId
+            ? this.currentLocation.copyWithLocations({ fragments: [`#${progression.fragmentId}`] })
+            : this.currentLocation;
+        this._notifyTimelineChange(locatorForTimeline);
         await this.framePool.update(this.pub, this.currentLocation, this.determineModules());
     }
 
@@ -663,9 +732,13 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         return this.pub;
     }
 
+    get timeline(): Timeline {
+        return this.pub.timeline;
+    }
+
     private async loadLocator(locator: Locator, cb: (ok: boolean) => void) {
         let done = false;
-        let cssSelector = (typeof locator.locations.getCssSelector === "function") && locator.locations.getCssSelector();
+        let cssSelector = getCssSelector(locator.locations);
         if(locator.text?.highlight) {
             done = await new Promise<boolean>((res, _) => {
                 // Attempt to go to a highlighted piece of text in the resource
@@ -697,7 +770,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         // This sanity check has to be performed because we're still passing non-locator class
         // locator objects to this function. This is not good and should eventually be forbidden
         // or the locator should be deserialized sometime before this function.
-        const hid = (typeof locator.locations.htmlId === "function") && locator.locations.htmlId();
+        const hid = getHtmlId(locator.locations);
         if(hid)
             done = await new Promise<boolean>((res, _) => {
                 // Attempt to go to an HTML ID in the resource
@@ -778,6 +851,14 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
             })
         });
     }
+
+    private _notifyTimelineChange(locator: Locator): void {
+        const item = this.timeline.locate(locator);
+        if (item !== this._currentTimelineItem) {
+            this._currentTimelineItem = item;
+            this.listeners.timelineItemChanged(item);
+        }
+    }
 }
 
 export const ExperimentalWebPubNavigator = WebPubNavigator;

package/src/webpub/preferences/WebPubDefaults.ts

@@ -14,7 +14,7 @@ import {
   ensureExperiment
 } from "../../preferences/guards.ts";
 
-import { sMLWithRequest } from "@readium/navigator-html-injectables";
+import { sMLWithRequest } from "@readium/helpers";
 
 export interface IWebPubDefaults {
   fontFamily?: string | null,

package/src/webpub/preferences/WebPubSettings.ts

@@ -3,7 +3,7 @@ import { ExperimentKey, TextAlignment } from "../../preferences/Types.ts";
 import { WebPubDefaults } from "./WebPubDefaults.ts";
 import { WebPubPreferences } from "./WebPubPreferences.ts";
 
-import { sMLWithRequest } from "@readium/navigator-html-injectables";
+import { sMLWithRequest } from "@readium/helpers";
 
 export interface IWebPubSettings {
   fontFamily?: string | null,

package/types/src/Navigator.d.ts

@@ -1,4 +1,4 @@
-import { Link, Locator, Publication, ReadingProgression } from "@readium/shared";
+import { Link, Locator, Publication, ReadingProgression, Timeline } from "@readium/shared";
 import { ContentProtectionConfig, PrintProtectionConfig, KeyboardPeripheral, KeyboardPeripheralEvent } from "@readium/navigator-html-injectables";
 type cbb = (ok: boolean) => void;
 export interface KeyboardPeripheralEventData extends Omit<KeyboardPeripheralEvent, 'interactiveElement'> {
@@ -10,6 +10,7 @@ export type IKeyboardPeripheralsConfig = Array<Omit<KeyboardPeripheral, 'type'>
 export interface ProgressionRange {
     start: number;
     end: number;
+    fragmentId?: string;
 }
 export interface VisualNavigatorViewport {
     readingOrder: string[];
@@ -24,6 +25,7 @@ export interface IContentProtectionConfig extends ContentProtectionConfig {
 export declare abstract class Navigator {
     abstract get publication(): Publication;
     abstract get currentLocator(): Locator;
+    abstract get timeline(): Timeline;
     /**
      * Moves to the position in the publication corresponding to the given {Locator}.
      */

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

@@ -1,60 +1,7 @@
-import type { Decoration as InjectableDecoration, BuiltinDecorationStyle, HTMLDecorationTemplate as WireHTMLDecorationTemplate } from "@readium/navigator-html-injectables";
-export type { BuiltinDecorationStyle };
-export { DecorationLayout, DecorationStyleType, DecorationWidth } from "@readium/navigator-html-injectables";
-/**
- * Navigator-level decoration template. `element` is a function called once per decoration to
- * generate the HTML string that the injectable will render. The result is resolved on the
- * navigator side (before postMessage) and sanitized by the injectable.
- */
-export interface HTMLDecorationTemplate extends Omit<WireHTMLDecorationTemplate, 'element'> {
-    element: (decoration: Decoration) => string;
-}
-export type DecorationStyle = BuiltinDecorationStyle | HTMLDecorationTemplate;
-export interface Decoration extends Omit<InjectableDecoration, 'style'> {
-    style: DecorationStyle;
-}
-/**
- * Resolves a navigator-level Decoration to a wire-safe plain object for postMessage.
- * For Template styles, calls `element(decoration)` and embeds the resulting HTML string.
- * For registered custom style IDs (found in `decorationTemplates`), resolves the template
- * and converts the style to a Template wire object.
- */
-export declare function resolveDecorationForWire(decoration: Decoration, decorationTemplates?: Record<string, HTMLDecorationTemplate>): unknown;
-export interface DecorationActivationEvent {
-    decoration: Decoration;
-    group: string;
-    /** Bounding rect of the activated decoration in navigator container coordinates (CSS pixels). */
-    rect?: {
-        top: number;
-        left: number;
-        width: number;
-        height: number;
-    };
-    /** Tap/click point in navigator container coordinates (CSS pixels). */
-    point?: {
-        x: number;
-        y: number;
-    };
-}
-export interface DecorationObserver {
-    /**
-     * Called when a user activates a decoration (click or tap).
-     * Return true to indicate the event was handled — this suppresses normal tap/click navigation.
-     */
-    onDecorationActivated(event: DecorationActivationEvent): boolean;
-}
-export declare function decorationsEqual(a: Decoration, b: Decoration): boolean;
-/** Configuration for decoration rendering. */
-export interface DecoratorConfig {
-    /**
-     * Named custom styles. Each key is a style type ID; the value is the template that
-     * generates the HTML for decorations of that type. When a decoration's `style.type`
-     * matches a key here, the navigator resolves the template and sends it to the
-     * injectable as a Template-type decoration.
-     */
-    decorationTemplates?: Record<string, HTMLDecorationTemplate>;
-}
-declare const BUILTIN_DECORATION_TYPES: Set<string>;
+import type { Decoration, DecorationObserver } from "@readium/decorator";
+import { DecorationStyleType } from "@readium/decorator";
+export type { Decoration, DecorationStyle, HTMLDecorationTemplate, NamedDecorationStyle, BuiltinDecorationStyle, DecoratorConfig, OnDecorationActivatedEvent, OnDecorationPointerEnterEvent, OnDecorationPointerLeaveEvent, DecorationObserver, } from "@readium/decorator";
+export { DecorationStyleType, DecorationLayout, DecorationWidth, BUILTIN_DECORATION_TYPES, resolveDecorationForWire, decorationsEqual, supportsDecorationStyle, } from "@readium/decorator";
 export interface DecorableNavigator {
     /**
      * Replaces all decorations for the given group with the provided list.
@@ -66,10 +13,9 @@ export interface DecorableNavigator {
      * Returns whether the given style type ID can be rendered by this navigator.
      * Returns true for all built-in types and any IDs registered in DecoratorConfig.
      */
-    supportsDecorationStyle(styleTypeId: string): boolean;
+    supportsDecorationStyle(styleTypeId: DecorationStyleType | string): boolean;
     /** Registers an observer for activation events on the given group. */
     registerDecorationObserver(group: string, observer: DecorationObserver): void;
     /** Unregisters a previously registered observer from all groups. */
     unregisterDecorationObserver(observer: DecorationObserver): void;
 }
-export { BUILTIN_DECORATION_TYPES };

package/types/src/epub/EpubNavigator.d.ts

@@ -1,9 +1,9 @@
-import { Layout, Link, Locator, Publication, ReadingProgression } from "@readium/shared";
+import { Layout, Link, Locator, Publication, ReadingProgression, Timeline, TimelineItem } from "@readium/shared";
 import { Configurable, ConfigurableSettings, VisualNavigator, VisualNavigatorViewport } from "../index.ts";
 import { FramePoolManager } from "./frame/FramePoolManager.ts";
 import { FXLFramePoolManager } from "./fxl/FXLFramePoolManager.ts";
 import { CommsEventKey, ContextMenuEvent, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
-import { Decoration, DecorationObserver, DecorableNavigator, DecoratorConfig } from "../decorations/index.ts";
+import { Decoration, DecorationObserver, DecorableNavigator, DecoratorConfig, DecorationStyleType } from "../decorations/index.ts";
 import { FXLFrameManager } from "./fxl/FXLFrameManager.ts";
 import { FrameManager } from "./frame/FrameManager.ts";
 import { IEpubPreferences, EpubPreferences } from "./preferences/EpubPreferences.ts";
@@ -24,6 +24,7 @@ export interface EpubNavigatorConfiguration {
 export interface EpubNavigatorListeners {
     frameLoaded: (wnd: Window) => void;
     positionChanged: (locator: Locator) => void;
+    timelineItemChanged: (item: TimelineItem | undefined) => void;
     tap: (e: FrameClickEvent) => boolean;
     click: (e: FrameClickEvent) => boolean;
     zoom: (scale: number) => void;
@@ -43,6 +44,8 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     private framePool;
     private positions;
     private currentLocation;
+    private _currentTimelineItem;
+    private _timelineAugmented;
     private lastLocationInView;
     private currentProgression;
     private _layout;
@@ -65,7 +68,9 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     private readonly _decoratorConfig;
     private _decorations;
     private _decorationObservers;
+    private _decorationHoveredDecorations;
     private _decorationActivationState;
+    private _decorationHoverState;
     private _decorationActivationConsumed;
     private reflowViewport;
     constructor(container: HTMLElement, pub: Publication, listeners: EpubNavigatorListeners, positions?: Locator[], initialPosition?: Locator | undefined, configuration?: EpubNavigatorConfiguration);
@@ -101,15 +106,18 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     private determineModules;
     private attachListener;
     private apply;
-    supportsDecorationStyle(styleTypeId: string): boolean;
+    supportsDecorationStyle(styleTypeId: DecorationStyleType | string): boolean;
     registerDecorationObserver(group: string, observer: DecorationObserver): void;
     unregisterDecorationObserver(observer: DecorationObserver): void;
     private _sendDecorationActivationToFrames;
+    private _sendDecorationHoverToFrames;
     applyDecorations(decorations: Decoration[], group: string): void;
     private _sendDecorationOps;
     private _reapplyDecorationsToFrame;
     private _reapplyDecorationsToCurrentFrames;
     private _handleDecorationActivated;
+    private _handleDecorationPointerEnter;
+    private _handleDecorationPointerLeave;
     destroy(): Promise<void>;
     private changeResource;
     private findLastPositionInProgressionRange;
@@ -127,7 +135,9 @@ export declare class EpubNavigator extends VisualNavigator implements Configurab
     get readingProgression(): ReadingProgression;
     private setLayout;
     get publication(): Publication;
+    get timeline(): Timeline;
     private loadLocator;
     go(locator: Locator, _: boolean, cb: (ok: boolean) => void): void;
     goLink(link: Link, animated: boolean, cb: (ok: boolean) => void): void;
+    private _notifyTimelineChange;
 }

package/types/src/epub/frame/FrameManager.d.ts

@@ -2,6 +2,7 @@ import { Loader, ModuleName } from "@readium/navigator-html-injectables";
 import { FrameComms } from "./FrameComms.ts";
 import type { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../../Navigator.ts";
 export declare class FrameManager {
+    private readonly timelineFragmentIds;
     private frame;
     private loader;
     readonly source: string;
@@ -12,7 +13,7 @@ export declare class FrameManager {
     private readonly keyboardPeripheralsConfig;
     private conditionBridge?;
     private currModules;
-    constructor(source: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
+    constructor(source: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig, timelineFragmentIds?: string[]);
     load(modules: ModuleName[]): Promise<Window>;
     private applyContentProtection;
     destroy(): Promise<void>;

package/types/src/epub/frame/FramePoolManager.d.ts

@@ -16,9 +16,10 @@ export declare class FramePoolManager {
     private readonly injector;
     private readonly contentProtectionConfig;
     private readonly keyboardPeripheralsConfig;
+    private readonly getFragmentIds;
     constructor(container: HTMLElement, positions: Locator[], cssProperties?: {
         [key: string]: string;
-    }, injector?: Injector | null, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
+    }, injector?: Injector | null, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig, getFragmentIds?: (href: string) => string[]);
     destroy(): Promise<void>;
     update(pub: Publication, locator: Locator, modules: ModuleName[], force?: boolean): Promise<void>;
     setCSSProperties(properties: {

package/types/src/epub/fxl/FXLFramePoolManager.d.ts

@@ -47,7 +47,7 @@ export declare class FXLFramePoolManager {
     private updateDimensions;
     get rtl(): boolean;
     private get single();
-    get perPage(): 1 | 2;
+    get perPage(): 2 | 1;
     get threshold(): number;
     get portrait(): boolean;
     updateSpineStyle(animate: boolean, fast?: boolean): void;

package/types/src/webpub/WebPubFrameManager.d.ts

@@ -2,6 +2,7 @@ import { Loader, ModuleName } from "@readium/navigator-html-injectables";
 import { FrameComms } from "../epub/frame/FrameComms.ts";
 import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator.ts";
 export declare class WebPubFrameManager {
+    private readonly timelineFragmentIds;
     private frame;
     private loader;
     readonly source: string;
@@ -12,7 +13,7 @@ export declare class WebPubFrameManager {
     private readonly keyboardPeripheralsConfig;
     private conditionBridge?;
     private currModules;
-    constructor(source: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
+    constructor(source: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig, timelineFragmentIds?: string[]);
     load(modules?: ModuleName[]): Promise<Window>;
     private applyContentProtection;
     destroy(): Promise<void>;

package/types/src/webpub/WebPubFramePoolManager.d.ts

@@ -15,9 +15,10 @@ export declare class WebPubFramePoolManager {
     private readonly injector?;
     private readonly contentProtectionConfig;
     private readonly keyboardPeripheralsConfig;
+    private readonly getFragmentIds;
     constructor(container: HTMLElement, cssProperties?: {
         [key: string]: string;
-    }, injector?: Injector | null, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
+    }, injector?: Injector | null, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig, getFragmentIds?: (href: string) => string[]);
     destroy(): Promise<void>;
     update(pub: Publication, locator: Locator, modules: ModuleName[]): Promise<void>;
     setCSSProperties(properties: {

package/types/src/webpub/WebPubNavigator.d.ts

@@ -1,9 +1,9 @@
-import { Link, Locator, Publication, ReadingProgression } from "@readium/shared";
+import { Link, Locator, Publication, ReadingProgression, Timeline, TimelineItem } from "@readium/shared";
 import { VisualNavigator, VisualNavigatorViewport, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
-import { Decoration, DecorableNavigator, DecorationObserver, DecoratorConfig } from "../decorations/index.ts";
+import { Decoration, DecorableNavigator, DecorationObserver, DecoratorConfig, DecorationStyleType } from "../decorations/index.ts";
 import { ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { IWebPubPreferences, WebPubPreferences } from "./preferences/WebPubPreferences.ts";
 import { IWebPubDefaults } from "./preferences/WebPubDefaults.ts";
@@ -22,6 +22,7 @@ export interface WebPubNavigatorConfiguration {
 export interface WebPubNavigatorListeners {
     frameLoaded: (wnd: Window) => void;
     positionChanged: (locator: Locator) => void;
+    timelineItemChanged: (item: TimelineItem | undefined) => void;
     tap: (e: FrameClickEvent) => boolean;
     click: (e: FrameClickEvent) => boolean;
     zoom: (scale: number) => void;
@@ -40,6 +41,7 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     private framePool;
     private currentIndex;
     private currentLocation;
+    private _currentTimelineItem;
     private _preferences;
     private _defaults;
     private _settings;
@@ -56,7 +58,9 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     private readonly _decoratorConfig;
     private _decorations;
     private _decorationObservers;
+    private _decorationHoveredDecorations;
     private _decorationActivationState;
+    private _decorationHoverState;
     private _decorationActivationConsumed;
     private webViewport;
     constructor(container: HTMLElement, pub: Publication, listeners: WebPubNavigatorListeners, initialPosition?: Locator | undefined, configuration?: WebPubNavigatorConfiguration);
@@ -79,14 +83,17 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     private attachListener;
     private apply;
     destroy(): Promise<void>;
-    supportsDecorationStyle(styleTypeId: string): boolean;
+    supportsDecorationStyle(styleTypeId: DecorationStyleType | string): boolean;
     registerDecorationObserver(group: string, observer: DecorationObserver): void;
     unregisterDecorationObserver(observer: DecorationObserver): void;
     private _sendDecorationActivatable;
+    private _sendDecorationHoverable;
     applyDecorations(decorations: Decoration[], group: string): void;
     private _sendDecorationOps;
     private _reapplyDecorationsToCurrentFrame;
     private _handleDecorationActivated;
+    private _handleDecorationPointerEnter;
+    private _handleDecorationPointerLeave;
     private changeResource;
     private updateViewport;
     private syncLocation;
@@ -100,9 +107,11 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     get canGoForward(): boolean;
     get readingProgression(): ReadingProgression;
     get publication(): Publication;
+    get timeline(): Timeline;
     private loadLocator;
     go(locator: Locator, _: boolean, cb: (ok: boolean) => void): void;
     goLink(link: Link, animated: boolean, cb: (ok: boolean) => void): void;
     private createCurrentLocator;
+    private _notifyTimelineChange;
 }
 export declare const ExperimentalWebPubNavigator: typeof WebPubNavigator;

package/dist/ar-DyHX_uy2.js

@@ -1,7 +0,0 @@
-const e = { metadata: { accessibility: { "display-guide": { "accessibility-summary": { "no-metadata": "لا تتوفر أي معلومات", "publisher-contact": "لمزيد من المعلومات حول إمكانية الوصول إلى هذا المنتج، يُرجى التواصل مع الناشر: ", title: "ملخص إمكانية الوصول" }, "additional-accessibility-information": { aria: { compact: "أدوار ARIA مدرَجة", descriptive: "يتم تعزيز المحتوى باستخدام أدوار ARIA لتحسين التنظيم وتيسير التنقّل" }, "audio-descriptions": "الوصف الصوتي", braille: "برايل", "color-not-sole-means-of-conveying-information": "اللون ليس الوسيلة الوحيدة لنقل المعلومات", "dyslexia-readability": "سهولة القراءة لذوي عُسر القراءة", "full-ruby-annotations": "شروح روبي كاملة", "high-contrast-between-foreground-and-background-audio": "تباين عالٍ بين الصوت الرئيسي وصوت الخلفية", "high-contrast-between-text-and-background": "تباين عالٍ بين النص والخلفية", "large-print": "خط كبير", "page-breaks": { compact: "فواصل الصفحات متضمَّنة", descriptive: "فواصل الصفحات متضمَّنة من المصدر المطبوع الأصلي" }, "ruby-annotations": "بعض شروح الروبي", "sign-language": "لغة الإشارة", "tactile-graphics": { compact: "الرسوم اللمسية مدرجة", descriptive: "تم دمج الرسوم اللمسية لتيسير الوصول إلى العناصر البصرية للأشخاص المكفوفين" }, "tactile-objects": "مجسمات لمسية ثلاثية الأبعاد", "text-to-speech-hinting": "إرشادات تحويل النص إلى كلام (TTS)متوفرة", title: "معلومات إضافية عن إمكانية الوصول", "ultra-high-contrast-between-text-and-background": "تباين عالٍ جدًا بين النص والخلفية", "visible-page-numbering": "ترقيم صفحات مرئي", "without-background-sounds": "من دون أصوات في خلفية" }, conformance: { a: { compact: "هذا المنشور يفي بالمعايير الدنيا لإمكانية الوصول", descriptive: "يحتوي هذا المنشور على بيان مطابقة يفيد بأنه يفي بمعيار إمكانية الوصول في EPUB وبمستوى A من معيار WCAG 2" }, aa: { compact: "هذا المنشور يفي بالمعايير المعتمدة لإمكانية الوصول", descriptive: "يحتوي هذا المنشور على بيان مطابقة يفيد بأنه يفي بمعيار إمكانية الوصول في EPUB وبمستوى AA من معيار WCAG 2" }, aaa: { compact: "هذا المنشور يفوق المعايير المقبولة لإمكانية الوصول", descriptive: "يحتوي هذا المنشور على بيان مطابقة يفيد بأنه يفي بمعيار إمكانية الوصول في EPUB وبمستوى AAA من معيار WCAG 2" }, certifier: "تم اعتماد هذا المنشور من قبل ", "certifier-credentials": "بيانات اعتماد جهة التصديق ", details: { "certification-info": "تم اعتماد هذا المنشور في تاريخ ", "certifier-report": "لمزيد من المعلومات، يرجى الرجوع إلى تقرير جهة التصديق", claim: "يدّعي هذا المنشور أنه يستوفي", "epub-accessibility-1-0": "معيار إمكانية الوصول لـ EPUB إصدار 1.0", "epub-accessibility-1-1": "معيار إمكانية الوصول لـ EPUB إصدار 1.1", "level-a": "المستوى A", "level-aa": "المستوى AA", "level-aaa": "المستوى AAA", "wcag-2-0": { compact: "WCAG 2.0", descriptive: "مبادئ النفاذ إلى محتوى الويب (WCAG) 2.0" }, "wcag-2-1": { compact: "WCAG 2.1", descriptive: "مبادئ النفاذ إلى محتوى الويب (WCAG) 2.1" }, "wcag-2-2": { compact: "WCAG 2.2", descriptive: "مبادئ النفاذ إلى محتوى الويب (WCAG) 2.2" } }, "details-title": "معلومات تفصيلية عن مدى المطابقة", no: "لا تتوفر أي معلومات", title: "المطابقة", "unknown-standard": "لا يمكن التأكد من مدى مطابقة هذا المنشور للمعايير المقبولة لإمكانية الوصول" }, hazards: { flashing: { compact: "محتوى وامض", descriptive: "يحتوي هذا المنشور على محتوى وامض قد يسبب نوبات حساسة للضوء" }, "flashing-none": { compact: "لا توجد مخاطر وميض", descriptive: "لا يحتوي هذا المنشور على محتوى وامض قد يسبب نوبات حساسة للضوء" }, "flashing-unknown": { compact: "مخاطر الوميض غير معروفة", descriptive: "لم يُمكن التأكد من وجود محتوى وامض قد يسبب نوبات حساسية للضوء" }, motion: { compact: "محاكاة الحركة", descriptive: "يحتوي المنشور على محاكاة حركة قد تسبّب دوار الحركة" }, "motion-none": { compact: "لا توجد مخاطر محاكاة الحركة", descriptive: "لا يحتوي المنشور على محاكاة حركة قد تسبّب دوار الحركة" }, "motion-unknown": { compact: "مخاطر محاكاة الحركة غير معروفة", descriptive: "تعذّر تحديد ما إذا كانت هناك محاكاة للحركة قد تُسبب دوار الحركة" }, "no-metadata": "لا تتوفر أي معلومات", none: { compact: "لا توجد مخاطر", descriptive: "لا يحتوي المنشور على أي مخاطر" }, sound: { compact: "أصوات", descriptive: "يحتوي المنشور على أصوات قد تؤدي إلى مشاكل حساسية صوتية" }, "sound-none": { compact: "لا توجد مخاطر صوتية", descriptive: "لا يحتوي المنشور على أصوات قد تؤدي إلى مشاكل حساسية صوتية" }, "sound-unknown": { compact: "مخاطر الصوت غير معروفة", descriptive: "تعذّر تحديد ما إذا كانت هناك أصوات قد تُسبب مشكلات في الحساسية" }, title: "مخاطر", unknown: "وجود المخاطر غير معروف" }, "legal-considerations": { exempt: { compact: "يُعلن عن استثناء من متطلبات إمكانية الوصول من بعض السلطات القضائية", descriptive: "يُصرّح هذا المنشور بوجود استثناء من متطلبات إمكانية الوصول من بعض السلطات القضائية" }, "no-metadata": "لا تتوفر أي معلومات", title: "اعتبارات قانونية" }, navigation: { index: { compact: "كشاف", descriptive: "كشاف يحتوي على روابط إلى الإدخالات المشار إليها" }, "no-metadata": "لا تتوفر أي معلومات", "page-navigation": { compact: "الانتقال إلى صفحة", descriptive: "قائمة الصفحات للانتقال إلى صفحات من النسخة المطبوعة الأصلية" }, structural: { compact: "العناوين", descriptive: "عناصر مثل العناوين والجداول وغيرها للتنقل المنظّم" }, title: "التنقل", toc: { compact: "جدول المحتويات", descriptive: "جدول المحتويات لكل فصول النص عبر روابط" } }, "rich-content": { "accessible-chemistry-as-latex": { compact: "الصيغ الكيميائية بصيغة LaTeX", descriptive: "الصيغ الكيميائية بشكل ميسر (LaTeX)" }, "accessible-chemistry-as-mathml": { compact: "الصيغ الكيميائية بصيغة MathML", descriptive: "الصيغ الكيميائية بشكل ميسر (MathML)" }, "accessible-math-as-latex": { compact: "الرياضيات بصيغة LaTeX", descriptive: "الصيغ الرياضية بشكل ميسر (LaTeX)" }, "accessible-math-described": "تتوفر أوصاف نصية للصيغ الرياضية", "closed-captions": { compact: "تحتوي الفيديوهات على شروح مغلقة", descriptive: "الفيديوهات الموجودة في المنشورات تحتوي على شروح مغلقة" }, "extended-descriptions": "يتم وصف الصور الغنية بالمعلومات بأوصاف مفصّلة", "math-as-mathml": { compact: "الرياضيات بصيغة MathML", descriptive: "الصيغ الرياضية بشكل ميسر(MathML)" }, "open-captions": { compact: "تحتوي الفيديوهات على شروح مدمجة", descriptive: "الفيديوهات الموجودة في المنشورات تحتوي على شروح مدمجة" }, title: "محتوى غني", transcript: "يتوفر نص(نصوص)", unknown: "لا تتوفر أي معلومات" }, "ways-of-reading": { "nonvisual-reading": { "alt-text": { compact: "يحتوي على نص بديل", descriptive: "يحتوي على أوصاف نصية بديلة للصور" }, "no-metadata": "لا تتوفر معلومات عن القراءة غير البصرية", none: { compact: "غير قابل للقراءة بصوتٍ عالٍ أو بطريقة برايل الديناميكية", descriptive: "المحتوى غير قابل للقراءة بصوتٍ عالٍ أو بطريقة برايل الديناميكية" }, "not-fully": { compact: "غير قابل للقراءة بالكامل بصوتٍ عالٍ أو بطريقة برايل الديناميكية", descriptive: "لن يكون كل المحتوى قابلًا للقراءة بصوتٍ عالٍ أو بطريقة برايل الديناميكية" }, readable: { compact: "قابل للقراءة بصوتٍ عالٍ أو بطريقة برايل الديناميكية", descriptive: "يمكن قراءة كل المحتوى بصوتٍ عالٍ أو بطريقة برايل الديناميكية" } }, "prerecorded-audio": { complementary: { compact: "مقاطع الصوت المسجّلة مسبقًا", descriptive: "مقاطع الصوت المسجّلة مسبقًا مدمجة في المحتوى" }, "no-metadata": "لا توجد معلومات عن الصوت المسجّل مسبقًا", only: { compact: "الصوت المسجّل مسبقًا فقط", descriptive: "كتاب صوتي بدون بديل نصي" }, synchronized: { compact: "صوت مسجّل مسبقًا متزامن مع النص", descriptive: "كل المحتوى متوفر كصوت مسجّل مسبقًا متزامن مع النص" } }, title: "طرق القراءة", "visual-adjustments": { modifiable: { compact: "يمكن تعديل المظهر", descriptive: "يمكن تعديل مظهر النص وتخطيط الصفحة وفقاً لإمكانات نظام القراءة (اسم الخط وحجمه، والمسافات بين الفقرات والجمل والكلمات والأحرف، بالإضافة إلى لون الخلفية والنص)" }, unknown: "لا توجد معلومات عن إمكانية تعديل المظهر", unmodifiable: { compact: "لا يمكن تعديل المظهر", descriptive: "لا يمكن تعديل مظهر النص وتخطيط الصفحات لأن تجربة القراءة قريبة من النسخة المطبوعة، ولكن تطبيقات القراءة ما زالت تتيح خيارات التكبير" } } } } }, altIdentifier_one: "رمز تعريفي بديل", altIdentifier_other: "رموز تعريفية بديلة", artist_one: "فنان", artist_other: "فنانون", author_one: "مؤلف", author_other: "مؤلفون", collection_one: "سلسلة تحريرية", collection_other: "سلاسل تحريرية", colorist_one: "ملوّن الألوان", colorist_other: "ملوّنو الألوان", contributor_one: "مساهم", contributor_other: "مساهمون", description: "وصف", duration: "مدة", editor_one: "محرر", editor_other: "محررون", identifier_one: "رمز تعريفي", identifier_other: "رموز تعريفية", illustrator_one: "رسًام", illustrator_other: "رسامون", imprint_one: "العلامة التجارية للنشر", imprint_other: "العلامات التجارية للنشر", inker_one: "مُحَبِّر", inker_other: "مُحَبِّرون", language_one: "اللغة", language_other: "اللغات", letterer_one: "خطّاط", letterer_other: "خطّاطون", modified: "تاريخ التعديل", narrator_one: "قارئ صوتي", narrator_other: "قرّاء صوتيون", numberOfPages: "عدد الصفحات في النسخة المطبوعة", penciler_one: "رسّام أولي", penciler_other: "رسّامون أوّليون", published: "تاريخ النشر", publisher_one: "ناشر", publisher_other: "ناشرون", series_one: "سلسلة", series_other: "سلاسل", subject_one: "موضوع", subject_other: "مواضيع", subtitle: "عنوان فرعي", title: "العنوان", translator_one: "مترجم", translator_other: "مترجمون" } }, t = {
-  publication: e
-};
-export {
-  t as default,
-  e as publication
-};