@readium/navigator 2.5.0 → 2.5.2-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/navigator",
-  "version": "2.5.0",
+  "version": "2.5.2-beta.1",
   "type": "module",
   "description": "Next generation SDK for publications in Web Apps",
   "author": "readium",

package/src/epub/EpubNavigator.ts

@@ -2,7 +2,7 @@ import { Layout, Link, Locator, Profile, Publication, ReadingProgression } from
 import { Configurable, ConfigurableSettings, LineLengths, ProgressionRange, VisualNavigator, VisualNavigatorViewport } from "../index.ts";
 import { FramePoolManager } from "./frame/FramePoolManager.ts";
 import { FXLFramePoolManager } from "./fxl/FXLFramePoolManager.ts";
-import { CommsEventKey, ContextMenuEvent, FXLModules, KeyboardEventData, ModuleLibrary, ModuleName, ReflowableModules, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
+import { CommsEventKey, ContextMenuEvent, FXLModules, ModuleLibrary, ModuleName, ReflowableModules, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent, KeyboardPeripheralEvent } from "@readium/navigator-html-injectables";
 import * as path from "path-browserify";
 import { FXLFrameManager } from "./fxl/FXLFrameManager.ts";
 import { FrameManager } from "./frame/FrameManager.ts";
@@ -23,6 +23,10 @@ import { getScriptMode } from "../helpers/scriptMode.ts";
 
 export type ManagerEventKey = "zoom";
 
+export interface KeyboardPeripheralEventData extends Omit<KeyboardPeripheralEvent, 'interactiveElement'> {
+    interactiveElement?: Element;
+}
+
 export interface EpubNavigatorConfiguration {
     preferences: IEpubPreferences;
     defaults: IEpubDefaults;
@@ -44,7 +48,7 @@ export interface EpubNavigatorListeners {
     textSelected: (selection: BasicTextSelection) => void;
     contentProtection: (type: string, data: SuspiciousActivityEvent) => void;
     contextMenu: (data: ContextMenuEvent) => void;
-    peripheral: (data: KeyboardEventData) => void;
+    peripheral: (data: KeyboardPeripheralEventData) => void;
     // showToc: () => void;
 }
 
@@ -540,7 +544,15 @@ export class EpubNavigator extends VisualNavigator implements Configurable<Confi
                 this.listeners.contextMenu(data as ContextMenuEvent);
                 break;
             case "keyboard_peripherals":
-                this.listeners.peripheral(data as KeyboardEventData);
+                const event = data as KeyboardPeripheralEvent;
+                const parsedEvent: KeyboardPeripheralEventData = { ...event, interactiveElement: undefined };
+                if (event.interactiveElement) {
+                    parsedEvent.interactiveElement = new DOMParser().parseFromString(
+                        event.interactiveElement,
+                        "text/html"
+                    ).body.children[0] as Element;
+                }
+                this.listeners.peripheral(parsedEvent);
                 break;
             case "log":
                 console.log(this._cframes[0]?.source?.split("/")[3], ...(data as any[]));

package/src/epub/css/Properties.ts

@@ -11,7 +11,6 @@ import {
 } from "../../css/Properties.ts";
 
 export interface IUserProperties {
-  advancedSettings?: boolean | null;
   a11yNormalize?: boolean | null;
   backgroundColor?: string | null;
   blendFilter?: boolean | null;

package/src/webpub/WebPubNavigator.ts

@@ -2,11 +2,11 @@ import { Feature, Link, Locator, Publication, ReadingProgression, LocatorLocatio
 import { VisualNavigator, VisualNavigatorViewport, ProgressionRange } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { WebPubFramePoolManager } from "./WebPubFramePoolManager.ts";
-import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, KeyboardEventData, ModuleName, SuspiciousActivityEvent, WebPubModules } from "@readium/navigator-html-injectables";
+import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, KeyboardPeripheralEvent, ModuleName, SuspiciousActivityEvent, WebPubModules } from "@readium/navigator-html-injectables";
 import * as path from "path-browserify";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
 
-import { ManagerEventKey } from "../epub/EpubNavigator.ts";
+import { KeyboardPeripheralEventData, ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { getScriptMode } from "../helpers/scriptMode.ts";
 import { WebPubCSS } from "./css/WebPubCSS.ts";
 import { WebUserProperties, WebRSProperties } from "./css/Properties.ts";
@@ -41,7 +41,7 @@ export interface WebPubNavigatorListeners {
     textSelected: (selection: BasicTextSelection) => void;
     contentProtection: (type: string, data: SuspiciousActivityEvent) => void;
     contextMenu: (data: ContextMenuEvent) => void;
-    peripheral: (data: KeyboardEventData) => void;
+    peripheral: (data: KeyboardPeripheralEventData) => void;
 }
 
 const defaultListeners = (listeners: WebPubNavigatorListeners): WebPubNavigatorListeners => ({
@@ -356,7 +356,15 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
                 this.listeners.contextMenu(data as ContextMenuEvent);
                 break;
             case "keyboard_peripherals":
-                this.listeners.peripheral(data as KeyboardEventData);
+                const event = data as KeyboardPeripheralEvent;
+                const parsedEvent: KeyboardPeripheralEventData = { ...event, interactiveElement: undefined };
+                if (event.interactiveElement) {
+                    parsedEvent.interactiveElement = new DOMParser().parseFromString(
+                        event.interactiveElement,
+                        "text/html"
+                    ).body.children[0] as Element;
+                }
+                this.listeners.peripheral(parsedEvent);
                 break;
             case "log":
                 console.log(this.framePool.currentFrames[0]?.source?.split("/")[3], ...(data as any[]));

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

@@ -2,7 +2,7 @@ import { Layout, Link, Locator, Publication, ReadingProgression } from "@readium
 import { Configurable, ConfigurableSettings, VisualNavigator, VisualNavigatorViewport } from "../index.ts";
 import { FramePoolManager } from "./frame/FramePoolManager.ts";
 import { FXLFramePoolManager } from "./fxl/FXLFramePoolManager.ts";
-import { CommsEventKey, ContextMenuEvent, KeyboardEventData, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
+import { CommsEventKey, ContextMenuEvent, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent, KeyboardPeripheralEvent } from "@readium/navigator-html-injectables";
 import { FXLFrameManager } from "./fxl/FXLFrameManager.ts";
 import { FrameManager } from "./frame/FrameManager.ts";
 import { IEpubPreferences, EpubPreferences } from "./preferences/EpubPreferences.ts";
@@ -12,6 +12,9 @@ import { EpubPreferencesEditor } from "./preferences/EpubPreferencesEditor.ts";
 import { IInjectablesConfig } from "../injection/Injectable.ts";
 import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator.ts";
 export type ManagerEventKey = "zoom";
+export interface KeyboardPeripheralEventData extends Omit<KeyboardPeripheralEvent, 'interactiveElement'> {
+    interactiveElement?: Element;
+}
 export interface EpubNavigatorConfiguration {
     preferences: IEpubPreferences;
     defaults: IEpubDefaults;
@@ -32,7 +35,7 @@ export interface EpubNavigatorListeners {
     textSelected: (selection: BasicTextSelection) => void;
     contentProtection: (type: string, data: SuspiciousActivityEvent) => void;
     contextMenu: (data: ContextMenuEvent) => void;
-    peripheral: (data: KeyboardEventData) => void;
+    peripheral: (data: KeyboardPeripheralEventData) => void;
 }
 export declare class EpubNavigator extends VisualNavigator implements Configurable<ConfigurableSettings, EpubPreferences> {
     private readonly pub;

package/types/src/epub/css/Properties.d.ts

@@ -1,7 +1,6 @@
 import { ExperimentKey, TextAlignment } from "../../preferences/Types.ts";
 import { BodyHyphens, BoxSizing, FontOpticalSizing, FontWidth, Ligatures, Properties, TypeScale, View } from "../../css/Properties.ts";
 export interface IUserProperties {
-    advancedSettings?: boolean | null;
     a11yNormalize?: boolean | null;
     backgroundColor?: string | null;
     blendFilter?: boolean | null;

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

@@ -1,9 +1,9 @@
 import { Link, Locator, Publication, ReadingProgression } from "@readium/shared";
 import { VisualNavigator, VisualNavigatorViewport } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
-import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, KeyboardEventData, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
+import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
-import { ManagerEventKey } from "../epub/EpubNavigator.ts";
+import { KeyboardPeripheralEventData, ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { IWebPubPreferences, WebPubPreferences } from "./preferences/WebPubPreferences.ts";
 import { IWebPubDefaults } from "./preferences/WebPubDefaults.ts";
 import { WebPubSettings } from "./preferences/WebPubSettings.ts";
@@ -29,7 +29,7 @@ export interface WebPubNavigatorListeners {
     textSelected: (selection: BasicTextSelection) => void;
     contentProtection: (type: string, data: SuspiciousActivityEvent) => void;
     contextMenu: (data: ContextMenuEvent) => void;
-    peripheral: (data: KeyboardEventData) => void;
+    peripheral: (data: KeyboardPeripheralEventData) => void;
 }
 export declare class WebPubNavigator extends VisualNavigator implements Configurable<WebPubSettings, WebPubPreferences> {
     private readonly pub;