@readium/navigator 2.2.1 → 2.2.2

package/package.json

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

package/src/webpub/WebPubNavigator.ts

@@ -1,9 +1,11 @@
-import { Link, Locator, Publication, ReadingProgression, LocatorLocations } from "@readium/shared";
+import { Feature, Link, Locator, Publication, ReadingProgression, LocatorLocations } from "@readium/shared";
 import { VisualNavigator, VisualNavigatorViewport, ProgressionRange } from "../Navigator";
 import { Configurable } from "../preferences/Configurable";
 import { WebPubFramePoolManager } from "./WebPubFramePoolManager";
 import { BasicTextSelection, CommsEventKey, FrameClickEvent, ModuleLibrary, ModuleName, WebPubModules } from "@readium/navigator-html-injectables";
 import * as path from "path-browserify";
+import { WebPubFrameManager } from "./WebPubFrameManager";
+
 import { ManagerEventKey } from "../epub/EpubNavigator";
 import { WebPubCSS } from "./css/WebPubCSS";
 import { WebUserProperties } from "./css/Properties";
@@ -12,7 +14,6 @@ import { IWebPubDefaults, WebPubDefaults } from "./preferences/WebPubDefaults";
 import { WebPubSettings } from "./preferences/WebPubSettings";
 import { IPreferencesEditor } from "../preferences/PreferencesEditor";
 import { WebPubPreferencesEditor } from "./preferences/WebPubPreferencesEditor";
-
 export interface WebPubNavigatorConfiguration {
     preferences: IWebPubPreferences;
     defaults: IWebPubDefaults;
@@ -71,7 +72,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         // Initialize preference system
         this._preferences = new WebPubPreferences(configuration.preferences);
         this._defaults = new WebPubDefaults(configuration.defaults);
-        this._settings = new WebPubSettings(this._preferences, this._defaults);
+        this._settings = new WebPubSettings(this._preferences, this._defaults, this.hasDisplayTransformability);
         this._css = new WebPubCSS({
             userProperties: new WebUserProperties({ zoom: this._settings.zoom })
         });
@@ -115,7 +116,7 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
     }
 
     private async applyPreferences() {
-        this._settings = new WebPubSettings(this._preferences, this._defaults);
+        this._settings = new WebPubSettings(this._preferences, this._defaults, this.hasDisplayTransformability);
 
         if (this._preferencesEditor !== null) {
             this._preferencesEditor = new WebPubPreferencesEditor(this._preferences, this.settings, this.pub.metadata);
@@ -146,6 +147,20 @@ export class WebPubNavigator extends VisualNavigator implements Configurable<Web
         this.framePool.setCSSProperties(properties);
     }
 
+    /**
+     * Exposed to the public to compensate for lack of implemented readium conveniences
+     * TODO remove when settings management is incorporated
+     */
+    public get _cframes(): (WebPubFrameManager | undefined)[] {
+        return this.framePool.currentFrames;
+    }
+
+    private get hasDisplayTransformability(): boolean {
+        return this.pub.metadata?.accessibility?.feature?.some(
+            f => f.value === Feature.DISPLAY_TRANSFORMABILITY.value
+        ) ?? false;
+    }
+
     public eventListener(key: CommsEventKey | ManagerEventKey, data: unknown) {
         switch (key) {
             case "_pong":

package/src/webpub/preferences/WebPubPreferencesEditor.ts

@@ -33,11 +33,17 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     this.preferences[key] = value;
   }
 
+  private get isDisplayTransformable(): boolean {
+    return this.metadata?.accessibility?.feature?.some(
+      f => f.value === Feature.DISPLAY_TRANSFORMABILITY.value
+    ) ?? false; // Default to false if no metadata
+  }
+
   get fontFamily(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.fontFamily,
       effectiveValue: this.settings.fontFamily || null,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("fontFamily", newValue || null);
       }
@@ -48,7 +54,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new RangePreference<number>({
       initialValue: this.preferences.fontWeight,
       effectiveValue: this.settings.fontWeight || 400,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: number | null | undefined) => {
         this.updatePreference("fontWeight", newValue || null);
       },
@@ -61,7 +67,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new BooleanPreference({
       initialValue: this.preferences.hyphens,
       effectiveValue: this.settings.hyphens || false,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: boolean | null | undefined) => {
         this.updatePreference("hyphens", newValue || null);
       }
@@ -72,7 +78,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new RangePreference<number>({
       initialValue: this.preferences.letterSpacing,
       effectiveValue: this.settings.letterSpacing || 0,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: number | null | undefined) => {
         this.updatePreference("letterSpacing", newValue || null);
       },
@@ -85,7 +91,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new BooleanPreference({
       initialValue: this.preferences.ligatures,
       effectiveValue: this.settings.ligatures || true,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: boolean | null | undefined) => {
         this.updatePreference("ligatures", newValue || null);
       }
@@ -96,7 +102,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new RangePreference<number>({
       initialValue: this.preferences.lineHeight,
       effectiveValue: this.settings.lineHeight,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: number | null | undefined) => {
         this.updatePreference("lineHeight", newValue || null);
       },
@@ -109,7 +115,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new BooleanPreference({
       initialValue: this.preferences.noRuby,
       effectiveValue: this.settings.noRuby || false,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: boolean | null | undefined) => {
         this.updatePreference("noRuby", newValue || null);
       }
@@ -120,7 +126,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new RangePreference<number>({
       initialValue: this.preferences.paragraphIndent,
       effectiveValue: this.settings.paragraphIndent || 0,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: number | null | undefined) => {
         this.updatePreference("paragraphIndent", newValue || null);
       },
@@ -133,7 +139,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new RangePreference<number>({
       initialValue: this.preferences.paragraphSpacing,
       effectiveValue: this.settings.paragraphSpacing || 0,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: number | null | undefined) => {
         this.updatePreference("paragraphSpacing", newValue || null);
       },
@@ -146,7 +152,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new EnumPreference<TextAlignment>({
       initialValue: this.preferences.textAlign,
       effectiveValue: this.settings.textAlign || TextAlignment.start,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: TextAlignment | null | undefined) => {
         this.updatePreference("textAlign", newValue || null);
       },
@@ -158,7 +164,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new BooleanPreference({
       initialValue: this.preferences.textNormalization,
       effectiveValue: this.settings.textNormalization || false,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: boolean | null | undefined) => {
         this.updatePreference("textNormalization", newValue || null);
       }
@@ -169,7 +175,7 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     return new RangePreference<number>({
       initialValue: this.preferences.wordSpacing,
       effectiveValue: this.settings.wordSpacing || 0,
-      isEffective: this.metadata?.accessibility?.feature?.includes(Feature.DISPLAY_TRANSFORMABILITY) ?? false,
+      isEffective: this.isDisplayTransformable,
       onChange: (newValue: number | null | undefined) => {
         this.updatePreference("wordSpacing", newValue || null);
       },

package/src/webpub/preferences/WebPubSettings.ts

@@ -20,65 +20,67 @@ export interface IWebPubSettings {
 }
 
 export class WebPubSettings implements ConfigurableSettings {
-  fontFamily: string | null;
-  fontWeight: number | null;
-  hyphens: boolean | null;
-  letterSpacing: number | null;
-  ligatures: boolean | null;
-  lineHeight: number | null;
-  noRuby: boolean | null;
-  paragraphIndent: number | null;
-  paragraphSpacing: number | null;
-  textAlign: TextAlignment | null;
-  textNormalization: boolean | null;
-  wordSpacing: number | null;
+  fontFamily: string | null = null;
+  fontWeight: number | null = null;
+  hyphens: boolean | null = null;
+  letterSpacing: number | null = null;
+  ligatures: boolean | null = null;
+  lineHeight: number | null = null;
+  noRuby: boolean | null = null;
+  paragraphIndent: number | null = null;
+  paragraphSpacing: number | null = null;
+  textAlign: TextAlignment | null = null;
+  textNormalization: boolean | null = null;
+  wordSpacing: number | null = null;
   zoom: number | null;
 
-  constructor(preferences: WebPubPreferences, defaults: WebPubDefaults) {
-    this.fontFamily = preferences.fontFamily || defaults.fontFamily || null;
-    this.fontWeight = preferences.fontWeight !== undefined 
-      ? preferences.fontWeight 
-      : defaults.fontWeight !== undefined 
-        ? defaults.fontWeight 
-        : null;
-    this.hyphens = typeof preferences.hyphens === "boolean" 
-      ? preferences.hyphens 
-      : defaults.hyphens ?? null;
-    this.letterSpacing = preferences.letterSpacing !== undefined 
-      ? preferences.letterSpacing 
-      : defaults.letterSpacing !== undefined 
-        ? defaults.letterSpacing 
-        : null;
-    this.ligatures = typeof preferences.ligatures === "boolean"
-      ? preferences.ligatures 
-      : defaults.ligatures ?? null;
-    this.lineHeight = preferences.lineHeight !== undefined 
-      ? preferences.lineHeight 
-      : defaults.lineHeight !== undefined 
-        ? defaults.lineHeight 
-        : null;
-    this.noRuby = typeof preferences.noRuby === "boolean" 
-      ? preferences.noRuby 
-      : defaults.noRuby ?? null;
-    this.paragraphIndent = preferences.paragraphIndent !== undefined 
-      ? preferences.paragraphIndent 
-      : defaults.paragraphIndent !== undefined 
-        ? defaults.paragraphIndent 
-        : null;
-    this.paragraphSpacing = preferences.paragraphSpacing !== undefined 
-      ? preferences.paragraphSpacing 
-      : defaults.paragraphSpacing !== undefined 
-        ? defaults.paragraphSpacing 
-        : null;
-    this.textAlign = preferences.textAlign || defaults.textAlign || null;
-    this.textNormalization = typeof preferences.textNormalization === "boolean" 
-      ? preferences.textNormalization 
-      : defaults.textNormalization ?? null;
-    this.wordSpacing = preferences.wordSpacing !== undefined 
-      ? preferences.wordSpacing 
-      : defaults.wordSpacing !== undefined 
-        ? defaults.wordSpacing 
-        : null;
+  constructor(preferences: WebPubPreferences, defaults: WebPubDefaults, hasDisplayTransformability: boolean) {
+    if (hasDisplayTransformability) {
+      this.fontFamily = preferences.fontFamily || defaults.fontFamily || null;
+      this.fontWeight = preferences.fontWeight !== undefined 
+        ? preferences.fontWeight 
+        : defaults.fontWeight !== undefined 
+          ? defaults.fontWeight 
+          : null;
+      this.hyphens = typeof preferences.hyphens === "boolean" 
+        ? preferences.hyphens 
+        : defaults.hyphens ?? null;
+      this.letterSpacing = preferences.letterSpacing !== undefined 
+        ? preferences.letterSpacing 
+        : defaults.letterSpacing !== undefined 
+          ? defaults.letterSpacing 
+          : null;
+      this.ligatures = typeof preferences.ligatures === "boolean"
+        ? preferences.ligatures 
+        : defaults.ligatures ?? null;
+      this.lineHeight = preferences.lineHeight !== undefined 
+        ? preferences.lineHeight 
+        : defaults.lineHeight !== undefined 
+          ? defaults.lineHeight 
+          : null;
+      this.noRuby = typeof preferences.noRuby === "boolean" 
+        ? preferences.noRuby 
+        : defaults.noRuby ?? null;
+      this.paragraphIndent = preferences.paragraphIndent !== undefined 
+        ? preferences.paragraphIndent 
+        : defaults.paragraphIndent !== undefined 
+          ? defaults.paragraphIndent 
+          : null;
+      this.paragraphSpacing = preferences.paragraphSpacing !== undefined 
+        ? preferences.paragraphSpacing 
+        : defaults.paragraphSpacing !== undefined 
+          ? defaults.paragraphSpacing 
+          : null;
+      this.textAlign = preferences.textAlign || defaults.textAlign || null;
+      this.textNormalization = typeof preferences.textNormalization === "boolean" 
+        ? preferences.textNormalization 
+        : defaults.textNormalization ?? null;
+      this.wordSpacing = preferences.wordSpacing !== undefined 
+        ? preferences.wordSpacing 
+        : defaults.wordSpacing !== undefined 
+          ? defaults.wordSpacing 
+          : null;
+    }
     this.zoom = preferences.zoom !== undefined
       ? preferences.zoom
       : defaults.zoom !== undefined

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

@@ -2,6 +2,7 @@ import { Link, Locator, Publication, ReadingProgression } from "@readium/shared"
 import { VisualNavigator, VisualNavigatorViewport } from "../Navigator";
 import { Configurable } from "../preferences/Configurable";
 import { BasicTextSelection, CommsEventKey, FrameClickEvent } from "@readium/navigator-html-injectables";
+import { WebPubFrameManager } from "./WebPubFrameManager";
 import { ManagerEventKey } from "../epub/EpubNavigator";
 import { IWebPubPreferences, WebPubPreferences } from "./preferences/WebPubPreferences";
 import { IWebPubDefaults } from "./preferences/WebPubDefaults";
@@ -44,6 +45,12 @@ export declare class WebPubNavigator extends VisualNavigator implements Configur
     private updateCSS;
     private compileCSSProperties;
     private commitCSS;
+    /**
+     * Exposed to the public to compensate for lack of implemented readium conveniences
+     * TODO remove when settings management is incorporated
+     */
+    get _cframes(): (WebPubFrameManager | undefined)[];
+    private get hasDisplayTransformability();
     eventListener(key: CommsEventKey | ManagerEventKey, data: unknown): void;
     private determineModules;
     private attachListener;

package/types/src/webpub/preferences/WebPubPreferencesEditor.d.ts

@@ -11,6 +11,7 @@ export declare class WebPubPreferencesEditor implements IPreferencesEditor {
     constructor(initialPreferences: WebPubPreferences, settings: WebPubSettings, metadata: Metadata);
     clear(): void;
     private updatePreference;
+    private get isDisplayTransformable();
     get fontFamily(): Preference<string>;
     get fontWeight(): RangePreference<number>;
     get hyphens(): BooleanPreference;

package/types/src/webpub/preferences/WebPubSettings.d.ts

@@ -31,5 +31,5 @@ export declare class WebPubSettings implements ConfigurableSettings {
     textNormalization: boolean | null;
     wordSpacing: number | null;
     zoom: number | null;
-    constructor(preferences: WebPubPreferences, defaults: WebPubDefaults);
+    constructor(preferences: WebPubPreferences, defaults: WebPubDefaults, hasDisplayTransformability: boolean);
 }