@readium/navigator 2.5.2-beta.3 → 2.5.2-beta.5

package/package.json

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

package/src/epub/frame/FrameManager.ts

@@ -3,6 +3,7 @@ import { FrameComms } from "./FrameComms.ts";
 import type { ReadiumWindow } from "../../../../navigator-html-injectables/types/src/helpers/dom";
 import { sML } from "../../helpers/index.ts";
 import type { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../../Navigator.ts";
+import { KeyboardConditionBridge } from "../../peripherals/KeyboardConditionBridge.ts";
 
 
 export class FrameManager {
@@ -14,6 +15,7 @@ export class FrameManager {
     private destroyed: boolean = false;
     private readonly contentProtectionConfig: IContentProtectionConfig;
     private readonly keyboardPeripheralsConfig: IKeyboardPeripheralsConfig;
+    private conditionBridge?: KeyboardConditionBridge;
     private currModules: ModuleName[] = [];
 
     constructor(
@@ -74,9 +76,17 @@ export class FrameManager {
         // Send content protection config
         this.comms!.send("peripherals_protection", this.contentProtectionConfig);
 
-        // Send keyboard peripherals separately
+        // Send keyboard peripherals, filtered through condition bridge
         if (this.keyboardPeripheralsConfig && this.keyboardPeripheralsConfig.length > 0) {
-            this.comms!.send("keyboard_peripherals", this.keyboardPeripheralsConfig);
+            this.conditionBridge?.destroy();
+            this.conditionBridge = new KeyboardConditionBridge(
+                this.keyboardPeripheralsConfig,
+                (serializable) => {
+                    if (serializable.length > 0)
+                        this.comms!.send("keyboard_peripherals", serializable);
+                }
+            );
+            this.conditionBridge.setup();
         }
 
         // Apply scroll protection
@@ -91,6 +101,7 @@ export class FrameManager {
     }
 
     async destroy() {
+        this.conditionBridge?.destroy();
         await this.hide();
         this.loader?.destroy();
         this.frame.remove();

package/src/epub/fxl/FXLFrameManager.ts

@@ -4,6 +4,7 @@ import { FrameComms } from "../frame/FrameComms.ts";
 import { FXLPeripherals } from "./FXLPeripherals.ts";
 import type { ReadiumWindow } from "../../../../navigator-html-injectables/types/src/helpers/dom";
 import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../../Navigator.ts";
+import { KeyboardConditionBridge } from "../../peripherals/KeyboardConditionBridge.ts";
 
 export class FXLFrameManager {
     private frame: HTMLIFrameElement;
@@ -13,6 +14,7 @@ export class FXLFrameManager {
     private readonly peripherals: FXLPeripherals;
     private readonly contentProtectionConfig: IContentProtectionConfig;
     private readonly keyboardPeripheralsConfig: IKeyboardPeripheralsConfig;
+    private conditionBridge?: KeyboardConditionBridge;
     private currModules: ModuleName[] = [];
 
     // NEW
@@ -159,6 +161,7 @@ export class FXLFrameManager {
     }
 
     async destroy() {
+        this.conditionBridge?.destroy();
         await this.unfocus();
         this.loader?.destroy();
         this.wrapper.remove();
@@ -213,9 +216,17 @@ export class FXLFrameManager {
         // Send content protection config
         this.comms!.send("peripherals_protection", this.contentProtectionConfig);
 
-        // Send keyboard peripherals separately
+        // Send keyboard peripherals, filtered through condition bridge
         if (this.keyboardPeripheralsConfig && this.keyboardPeripheralsConfig.length > 0) {
-            this.comms!.send("keyboard_peripherals", this.keyboardPeripheralsConfig);
+            this.conditionBridge?.destroy();
+            this.conditionBridge = new KeyboardConditionBridge(
+                this.keyboardPeripheralsConfig,
+                (serializable) => {
+                    if (serializable.length > 0)
+                        this.comms!.send("keyboard_peripherals", serializable);
+                }
+            );
+            this.conditionBridge.setup();
         }
 
         // Apply print protection if configured

package/src/peripherals/KeyboardConditionBridge.ts

@@ -0,0 +1,47 @@
+import { KeyCombo, KeyboardPeripheral } from "@readium/navigator-html-injectables";
+
+export class KeyboardConditionBridge {
+    private unsubs: Array<() => void> = [];
+    private conditionValues = new Map<KeyCombo, boolean>();
+
+    constructor(
+        private config: KeyboardPeripheral[],
+        private onUpdate: (serializable: KeyboardPeripheral[]) => void
+    ) {}
+
+    setup() {
+        let initializing = true;
+
+        this.config.forEach(peripheral =>
+            peripheral.keyCombos.forEach(combo => {
+                if (combo.condition) {
+                    const unsub = combo.condition.subscribe((value) => {
+                        this.conditionValues.set(combo, value);
+                        if (!initializing) this.onUpdate(this.buildSerializable());
+                    });
+                    this.unsubs.push(unsub);
+                }
+            })
+        );
+
+        initializing = false;
+        this.onUpdate(this.buildSerializable());
+    }
+
+    private buildSerializable(): KeyboardPeripheral[] {
+        return this.config
+            .map(peripheral => ({
+                ...peripheral,
+                keyCombos: peripheral.keyCombos
+                    .filter(combo => !combo.condition || this.conditionValues.get(combo) === true)
+                    .map(({ condition, ...rest }) => rest),
+            }))
+            .filter(p => p.keyCombos.length > 0);
+    }
+
+    destroy() {
+        this.unsubs.forEach(u => u());
+        this.unsubs = [];
+        this.conditionValues.clear();
+    }
+}

package/src/webpub/WebPubFrameManager.ts

@@ -3,6 +3,7 @@ import { FrameComms } from "../epub/frame/FrameComms.ts";
 import type { ReadiumWindow } from "../../../navigator-html-injectables/types/src/helpers/dom";
 import { sML } from "../helpers/index.ts";
 import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator.ts";
+import { KeyboardConditionBridge } from "../peripherals/KeyboardConditionBridge.ts";
 
 export class WebPubFrameManager {
     private frame: HTMLIFrameElement;
@@ -13,6 +14,7 @@ export class WebPubFrameManager {
     private destroyed: boolean = false;
     private readonly contentProtectionConfig: IContentProtectionConfig;
     private readonly keyboardPeripheralsConfig: IKeyboardPeripheralsConfig;
+    private conditionBridge?: KeyboardConditionBridge;
     private currModules: ModuleName[] = [];
 
     constructor(
@@ -72,9 +74,17 @@ export class WebPubFrameManager {
         // Send content protection config
         this.comms!.send("peripherals_protection", this.contentProtectionConfig);
 
-        // Send keyboard peripherals separately
+        // Send keyboard peripherals, filtered through condition bridge
         if (this.keyboardPeripheralsConfig && this.keyboardPeripheralsConfig.length > 0) {
-            this.comms!.send("keyboard_peripherals", this.keyboardPeripheralsConfig);
+            this.conditionBridge?.destroy();
+            this.conditionBridge = new KeyboardConditionBridge(
+                this.keyboardPeripheralsConfig,
+                (serializable) => {
+                    if (serializable.length > 0)
+                        this.comms!.send("keyboard_peripherals", serializable);
+                }
+            );
+            this.conditionBridge.setup();
         }
 
         // Apply scroll protection if enabled
@@ -89,6 +99,7 @@ export class WebPubFrameManager {
     }
 
     async destroy() {
+        this.conditionBridge?.destroy();
         await this.hide();
         this.loader?.destroy();
         this.frame.remove();

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

@@ -10,6 +10,7 @@ export declare class FrameManager {
     private destroyed;
     private readonly contentProtectionConfig;
     private readonly keyboardPeripheralsConfig;
+    private conditionBridge?;
     private currModules;
     constructor(source: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
     load(modules: ModuleName[]): Promise<Window>;

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

@@ -11,6 +11,7 @@ export declare class FXLFrameManager {
     private readonly peripherals;
     private readonly contentProtectionConfig;
     private readonly keyboardPeripheralsConfig;
+    private conditionBridge?;
     private currModules;
     wrapper: HTMLDivElement;
     debugHref: string;

package/types/src/peripherals/KeyboardConditionBridge.d.ts

@@ -0,0 +1,11 @@
+import { KeyboardPeripheral } from "@readium/navigator-html-injectables";
+export declare class KeyboardConditionBridge {
+    private config;
+    private onUpdate;
+    private unsubs;
+    private conditionValues;
+    constructor(config: KeyboardPeripheral[], onUpdate: (serializable: KeyboardPeripheral[]) => void);
+    setup(): void;
+    private buildSerializable;
+    destroy(): void;
+}

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

@@ -10,6 +10,7 @@ export declare class WebPubFrameManager {
     private destroyed;
     private readonly contentProtectionConfig;
     private readonly keyboardPeripheralsConfig;
+    private conditionBridge?;
     private currModules;
     constructor(source: string, contentProtectionConfig?: IContentProtectionConfig, keyboardPeripheralsConfig?: IKeyboardPeripheralsConfig);
     load(modules?: ModuleName[]): Promise<Window>;