@readium/navigator 1.3.4 → 2.0.0-beta.10

package/src/epub/fxl/FXLFramePoolManager.ts

@@ -5,6 +5,7 @@ import FrameBlobBuider from "../frame/FrameBlobBuilder";
 import { FXLFrameManager } from "./FXLFrameManager";
 import { FXLPeripherals } from "./FXLPeripherals";
 import { FXLSpreader } from "./FXLSpreader";
+import { VisualNavigatorViewport } from "../../Navigator";
 
 const UPPER_BOUNDARY = 8;
 const LOWER_BOUNDARY = 5;
@@ -39,7 +40,6 @@ export class FXLFramePoolManager {
     private readonly spreadPresentation: Spread;
     private orientationInternal = -1; // Portrait = 1, Landscape = 0, Unknown = -1
     private containerHeightCached: number;
-    private readonly resizeBoundHandler: EventListenerOrEventListenerObject;
     private resizeTimeout: number | undefined;
     // private readonly pages: FXLFrameManager[] = [];
     public readonly peripherals: FXLPeripherals;
@@ -57,10 +57,6 @@ export class FXLFramePoolManager {
         // NEW
         this.spreader = new FXLSpreader(this.pub);
         this.containerHeightCached = container.clientHeight;
-        this.resizeBoundHandler = this.nativeResizeHandler.bind(this);
-
-        this.ownerWindow.addEventListener("resize", this.resizeBoundHandler);
-        this.ownerWindow.addEventListener("orientationchange", this.resizeBoundHandler);
 
         this.bookElement = document.createElement("div");
         this.bookElement.ariaLabel = "Book";
@@ -101,10 +97,6 @@ export class FXLFramePoolManager {
         return this.peripherals.pan.touchID > 0;
     }
 
-    private nativeResizeHandler(_: Event) {
-        this.resizeHandler(true);
-    }
-
     /**
      * When window resizes, resize slider components as well
      */
@@ -259,8 +251,8 @@ export class FXLFramePoolManager {
         return this.spreader.nLandscape;
     }
 
-    public setPerPage(perPage: number) {
-        if(perPage === 0) {
+    public setPerPage(perPage: number | null) {
+        if(perPage === null) {
             // TODO this mode is auto
             this.spread = true;
         } else if(perPage === 1) {
@@ -376,9 +368,6 @@ export class FXLFramePoolManager {
 
 
     async destroy() {
-        this.ownerWindow.removeEventListener("resize", this.resizeBoundHandler);
-        this.ownerWindow.removeEventListener("orientationchange", this.resizeBoundHandler);
-
         // Wait for all in-progress loads to complete
         let iit = this.inprogress.values();
         let inp = iit.next();
@@ -614,7 +603,25 @@ export class FXLFramePoolManager {
         return ret as DOMRect;
     }
 
-    get currentNumbers(): number[] {
+    get viewport(): VisualNavigatorViewport {
+        const viewport: VisualNavigatorViewport = {
+            readingOrder: [],
+            progressions: new Map(),
+            positions: null
+        };
+        const currentSpread = this.spreader.currentSpread(this.currentSlide, this.perPage);
+        currentSpread.forEach(link => {
+            viewport.readingOrder.push(link.href);
+            viewport.progressions.set(link.href, { start: 0, end: 1 }); // FXL always uses [0,1] progression
+        });
+
+        // Set positions using currentNumbers
+        viewport.positions = this.getCurrentNumbers();
+    
+        return viewport;
+    }
+
+    private getCurrentNumbers(): number[] {
         if(this.perPage < 2) {
             const link = this.pub.readingOrder.items[this.currentSlide];
             return [link.properties?.otherProperties["number"]];
@@ -629,4 +636,4 @@ export class FXLFramePoolManager {
     deselect() {
         this.currentFrames?.forEach(f => f?.deselect());
     }
-}
+}

package/src/epub/index.ts

@@ -1,3 +1,5 @@
 export * from "./EpubNavigator";
 export * from "./frame";
-export * from "./fxl";
+export * from "./fxl";
+export * from "./preferences";
+export * from "./css";

package/src/epub/preferences/EpubDefaults.ts

@@ -0,0 +1,165 @@
+import { 
+  fontSizeRangeConfig, 
+  fontWeightRangeConfig, 
+  fontWidthRangeConfig, 
+  LayoutStrategy, 
+  TextAlignment, 
+  Theme 
+} from "../../preferences/Types";
+
+import { 
+  ensureBoolean, 
+  ensureEnumValue, 
+  ensureFilter, 
+  ensureLessThanOrEqual, 
+  ensureMoreThanOrEqual, 
+  ensureNonNegative, 
+  ensureString, 
+  ensureValueInRange, 
+  withFallback
+} from "./guards";
+
+import { sMLWithRequest } from "../../helpers";
+
+export interface IEpubDefaults {
+  backgroundColor?: string | null,
+  blendFilter?: boolean | null,
+  columnCount?: number | null,
+  constraint?: number | null,
+  darkenFilter?: boolean | number | null,
+  deprecatedFontSize?: boolean | null,
+  fontFamily?: string | null,
+  fontSize?: number | null,
+  fontSizeNormalize?: boolean | null,
+  fontOpticalSizing?: boolean | null,
+  fontWeight?: number | null,
+  fontWidth?: number | null,
+  hyphens?: boolean | null,
+  invertFilter?: boolean | number | null,
+  invertGaijiFilter?: boolean | number | null,
+  iOSPatch?: boolean | null,
+  iPadOSPatch?: boolean | null,
+  layoutStrategy?: LayoutStrategy | null,
+  letterSpacing?: number | null,
+  ligatures?: boolean | null,
+  lineHeight?: number | null,
+  linkColor?: string | null,
+  maximalLineLength?: number | null,
+  minimalLineLength?: number | null,
+  noRuby?: boolean | null,
+  optimalLineLength?: number | null,
+  pageGutter?: number | null,
+  paragraphIndent?: number | null,
+  paragraphSpacing?: number | null,
+  scroll?: boolean | null,
+  scrollPaddingTop?: number | null,
+  scrollPaddingBottom?: number | null,
+  // scrollPaddingLeft?: number | null,
+  // scrollPaddingRight?: number | null,
+  selectionBackgroundColor?: string | null,
+  selectionTextColor?: string | null,
+  textAlign?: TextAlignment | null,
+  textColor?: string | null,
+  textNormalization?: boolean | null,
+  theme?: Theme | null,
+  visitedColor?: string | null,
+  wordSpacing?: number | null
+}
+
+export class EpubDefaults {
+  backgroundColor: string | null;
+  blendFilter: boolean | null;
+  columnCount: number | null;
+  constraint: number;
+  darkenFilter: boolean | number | null;
+  deprecatedFontSize?: boolean | null;
+  fontFamily: string | null;
+  fontSize: number | null;
+  fontSizeNormalize: boolean | null;
+  fontOpticalSizing: boolean | null;
+  fontWeight: number | null;
+  fontWidth: number | null;
+  hyphens: boolean | null;
+  invertFilter: boolean | number | null;
+  invertGaijiFilter: boolean | number | null;
+  iOSPatch: boolean;
+  iPadOSPatch: boolean;
+  layoutStrategy: LayoutStrategy | null;
+  letterSpacing: number | null;
+  ligatures: boolean | null;
+  lineHeight: number | null;
+  linkColor: string | null;
+  maximalLineLength: number | null;
+  minimalLineLength: number | null;
+  noRuby: boolean | null;
+  optimalLineLength: number;
+  pageGutter: number | null;
+  paragraphIndent: number | null;
+  paragraphSpacing: number | null;
+  scroll: boolean | null;
+  scrollPaddingTop: number | null;
+  scrollPaddingBottom: number | null;
+  // scrollPaddingLeft: number | null;
+  // scrollPaddingRight: number | null;
+  selectionBackgroundColor: string | null;
+  selectionTextColor: string | null;
+  textAlign: TextAlignment | null;
+  textColor: string | null;
+  textNormalization: boolean | null;
+  theme: Theme | null;
+  visitedColor: string | null;
+  wordSpacing: number | null;
+
+  constructor(defaults: IEpubDefaults) {
+    this.backgroundColor = ensureString(defaults.backgroundColor) || null;
+    this.blendFilter = ensureBoolean(defaults.blendFilter) ?? false;
+    this.constraint = ensureNonNegative(defaults.constraint) || 0;
+    this.columnCount = ensureNonNegative(defaults.columnCount) || null;
+    this.darkenFilter = ensureFilter(defaults.darkenFilter) ?? false;
+    this.deprecatedFontSize = ensureBoolean(defaults.deprecatedFontSize);
+    if (this.deprecatedFontSize === false || this.deprecatedFontSize === null) {
+      this.deprecatedFontSize = !CSS.supports("zoom", "1");
+    }
+    this.fontFamily = ensureString(defaults.fontFamily) || null;
+    this.fontSize = ensureValueInRange(defaults.fontSize, fontSizeRangeConfig.range) || 1;
+    this.fontSizeNormalize = ensureBoolean(defaults.fontSizeNormalize) ?? false;
+    this.fontOpticalSizing = ensureBoolean(defaults.fontOpticalSizing) ?? null;
+    this.fontWeight = ensureValueInRange(defaults.fontWeight, fontWeightRangeConfig.range) || null;
+    this.fontWidth = ensureValueInRange(defaults.fontWidth,fontWidthRangeConfig.range) || null;
+    this.hyphens = ensureBoolean(defaults.hyphens) ?? null;
+    this.invertFilter = ensureFilter(defaults.invertFilter) ?? false;
+    this.invertGaijiFilter = ensureFilter(defaults.invertGaijiFilter) ?? false;
+    this.iOSPatch = defaults.iOSPatch === false 
+        ? false 
+        : ((sMLWithRequest.OS.iOS || sMLWithRequest.OS.iPadOS) && sMLWithRequest.iOSRequest === "mobile");
+    this.iPadOSPatch = defaults.iPadOSPatch === false 
+        ? false 
+        : (sMLWithRequest.OS.iPadOS && sMLWithRequest.iOSRequest === "desktop");
+    this.layoutStrategy = ensureEnumValue<LayoutStrategy>(defaults.layoutStrategy, LayoutStrategy) || LayoutStrategy.lineLength;
+    this.letterSpacing = ensureNonNegative(defaults.letterSpacing) || null;
+    this.ligatures = ensureBoolean(defaults.ligatures) ?? null;
+    this.lineHeight = ensureNonNegative(defaults.lineHeight) || null;
+    this.linkColor = ensureString(defaults.linkColor) || null;
+    this.noRuby = ensureBoolean(defaults.noRuby) ?? false;
+    this.pageGutter = withFallback(ensureNonNegative(defaults.pageGutter), 20);
+    this.paragraphIndent = ensureNonNegative(defaults.paragraphIndent) ?? null;
+    this.paragraphSpacing = ensureNonNegative(defaults.paragraphSpacing) ?? null;
+    this.scroll = ensureBoolean(defaults.scroll) ?? false;
+    this.scrollPaddingTop = ensureNonNegative(defaults.scrollPaddingTop) ?? null;
+    this.scrollPaddingBottom = ensureNonNegative(defaults.scrollPaddingBottom) ?? null;
+    // this.scrollPaddingLeft = ensureNonNegative(defaults.scrollPaddingLeft) ?? null;
+    // this.scrollPaddingRight = ensureNonNegative(defaults.scrollPaddingRight) ?? null;
+    this.selectionBackgroundColor = ensureString(defaults.selectionBackgroundColor) || null;
+    this.selectionTextColor = ensureString(defaults.selectionTextColor) || null;
+    this.textAlign = ensureEnumValue<TextAlignment>(defaults.textAlign, TextAlignment) || null;
+    this.textColor = ensureString(defaults.textColor) || null;
+    this.textNormalization = ensureBoolean(defaults.textNormalization) ?? false;
+    this.theme = ensureEnumValue<Theme>(defaults.theme, Theme) || null;
+    this.visitedColor = ensureString(defaults.visitedColor) || null;
+    this.wordSpacing = ensureNonNegative(defaults.wordSpacing) || null;
+
+    this.optimalLineLength = ensureNonNegative(defaults.optimalLineLength) || 65;
+    this.maximalLineLength = withFallback(ensureMoreThanOrEqual(defaults.maximalLineLength, this.optimalLineLength), 80);
+    this.minimalLineLength = withFallback(ensureLessThanOrEqual(defaults.minimalLineLength, this.optimalLineLength), 40);
+  }
+}

package/src/epub/preferences/EpubPreferences.ts

@@ -0,0 +1,192 @@
+import { ConfigurablePreferences } from "../../preferences/Configurable";
+
+import { 
+  LayoutStrategy,
+  TextAlignment, 
+  Theme, 
+  fontSizeRangeConfig, 
+  fontWeightRangeConfig, 
+  fontWidthRangeConfig 
+} from "../../preferences/Types";
+
+import { 
+  ensureBoolean, 
+  ensureEnumValue, 
+  ensureFilter, 
+  ensureNonNegative, 
+  ensureString, 
+  ensureValueInRange 
+} from "./guards";
+
+export interface IEpubPreferences {
+  backgroundColor?: string | null,
+  blendFilter?: boolean | null,
+  columnCount?: number | null,
+  constraint?: number | null,
+  darkenFilter?: boolean | number | null,
+  deprecatedFontSize?: boolean | null,
+  fontFamily?: string | null,
+  fontSize?: number | null,
+  fontSizeNormalize?: boolean | null,
+  fontOpticalSizing?: boolean | null,
+  fontWeight?: number | null,
+  fontWidth?: number | null,
+  hyphens?: boolean | null,
+  invertFilter?: boolean | number | null,
+  invertGaijiFilter?: boolean | number | null,
+  iOSPatch?: boolean | null,
+  iPadOSPatch?: boolean | null,
+  layoutStrategy?: LayoutStrategy | null,
+  letterSpacing?: number | null,
+  ligatures?: boolean | null,
+  lineHeight?: number | null,
+  linkColor?: string | null,
+  maximalLineLength?: number | null,
+  minimalLineLength?: number | null,
+  noRuby?: boolean | null,
+  optimalLineLength?: number | null,
+  pageGutter?: number | null,
+  paragraphIndent?: number | null,
+  paragraphSpacing?: number | null,
+  scroll?: boolean | null,
+  scrollPaddingTop?: number | null,
+  scrollPaddingBottom?: number | null,
+  // scrollPaddingLeft?: number | null,
+  // scrollPaddingRight?: number | null,
+  selectionBackgroundColor?: string | null,
+  selectionTextColor?: string | null,
+  textAlign?: TextAlignment | null,
+  textColor?: string | null,
+  textNormalization?: boolean | null,
+  theme?: Theme | null,
+  visitedColor?: string | null,
+  wordSpacing?: number | null
+}
+
+export class EpubPreferences implements ConfigurablePreferences {
+  backgroundColor?: string | null;
+  blendFilter?: boolean | null;
+  constraint?: number | null;
+  columnCount?: number | null;
+  darkenFilter?: boolean | number | null;
+  deprecatedFontSize?: boolean | null;
+  fontFamily?: string | null;
+  fontSize?: number | null;
+  fontSizeNormalize?: boolean | null;
+  fontOpticalSizing?: boolean | null;
+  fontWeight?: number | null;
+  fontWidth?: number | null;
+  hyphens?: boolean | null;
+  invertFilter?: boolean | number | null;
+  invertGaijiFilter?: boolean | number | null;
+  iOSPatch?: boolean | null;
+  iPadOSPatch?: boolean | null;
+  layoutStrategy?: LayoutStrategy | null;
+  letterSpacing?: number | null;
+  ligatures?: boolean | null;
+  lineHeight?: number | null;
+  linkColor?: string | null;
+  maximalLineLength?: number | null;
+  minimalLineLength?: number | null;
+  noRuby?: boolean | null;
+  optimalLineLength?: number | null;
+  pageGutter?: number | null;
+  paragraphIndent?: number | null;
+  paragraphSpacing?: number | null;
+  scroll?: boolean | null;
+  scrollPaddingTop?: number | null;
+  scrollPaddingBottom?: number | null;
+  // scrollPaddingLeft?: number | null;
+  // scrollPaddingRight?: number | null;
+  selectionBackgroundColor?: string | null;
+  selectionTextColor?: string | null;
+  textAlign?: TextAlignment | null;
+  textColor?: string | null;
+  textNormalization?: boolean | null;
+  theme?: Theme | null;
+  visitedColor?: string | null;
+  wordSpacing?: number | null;
+
+  constructor(preferences: IEpubPreferences = {}) {
+    this.backgroundColor = ensureString(preferences.backgroundColor);
+    this.blendFilter = ensureBoolean(preferences.blendFilter);
+    this.constraint = ensureNonNegative(preferences.constraint);
+    this.columnCount = ensureNonNegative(preferences.columnCount);
+    this.darkenFilter = ensureFilter(preferences.darkenFilter);
+    this.deprecatedFontSize = ensureBoolean(preferences.deprecatedFontSize);
+    this.fontFamily = ensureString(preferences.fontFamily);
+    this.fontSize = ensureValueInRange(preferences.fontSize, fontSizeRangeConfig.range);
+    this.fontSizeNormalize = ensureBoolean(preferences.fontSizeNormalize);
+    this.fontOpticalSizing = ensureBoolean(preferences.fontOpticalSizing);
+    this.fontWeight = ensureValueInRange(preferences.fontWeight, fontWeightRangeConfig.range);
+    this.fontWidth = ensureValueInRange(preferences.fontWidth,fontWidthRangeConfig.range);
+    this.hyphens = ensureBoolean(preferences.hyphens);
+    this.invertFilter = ensureFilter(preferences.invertFilter);
+    this.invertGaijiFilter = ensureFilter(preferences.invertGaijiFilter);
+    this.iOSPatch = ensureBoolean(preferences.iOSPatch);
+    this.iPadOSPatch = ensureBoolean(preferences.iPadOSPatch);
+    this.layoutStrategy = ensureEnumValue<LayoutStrategy>(preferences.layoutStrategy, LayoutStrategy);
+    this.letterSpacing = ensureNonNegative(preferences.letterSpacing);
+    this.ligatures = ensureBoolean(preferences.ligatures);
+    this.lineHeight = ensureNonNegative(preferences.lineHeight);
+    this.linkColor = ensureString(preferences.linkColor);
+    this.noRuby = ensureBoolean(preferences.noRuby);
+    this.pageGutter = ensureNonNegative(preferences.pageGutter);
+    this.paragraphIndent = ensureNonNegative(preferences.paragraphIndent);
+    this.paragraphSpacing = ensureNonNegative(preferences.paragraphSpacing);
+    this.scroll = ensureBoolean(preferences.scroll);
+    this.scrollPaddingTop = ensureNonNegative(preferences.scrollPaddingTop);
+    this.scrollPaddingBottom = ensureNonNegative(preferences.scrollPaddingBottom);
+    // this.scrollPaddingLeft = ensureNonNegative(preferences.scrollPaddingLeft);
+    // this.scrollPaddingRight = ensureNonNegative(preferences.scrollPaddingRight);
+    this.selectionBackgroundColor = ensureString(preferences.selectionBackgroundColor);
+    this.selectionTextColor = ensureString(preferences.selectionTextColor);
+    this.textAlign = ensureEnumValue<TextAlignment>(preferences.textAlign, TextAlignment);
+    this.textColor = ensureString(preferences.textColor);
+    this.textNormalization = ensureBoolean(preferences.textNormalization);
+    this.theme = ensureEnumValue<Theme>(preferences.theme, Theme);
+    this.visitedColor = ensureString(preferences.visitedColor);
+    this.wordSpacing = ensureNonNegative(preferences.wordSpacing);
+
+    this.optimalLineLength = ensureNonNegative(preferences.optimalLineLength);
+    this.maximalLineLength = ensureNonNegative(preferences.maximalLineLength);
+    this.minimalLineLength = ensureNonNegative(preferences.minimalLineLength);
+  }
+
+  static serialize(preferences: EpubPreferences): string {
+    const { ...properties } = preferences;
+    return JSON.stringify(properties);
+  }
+
+  static deserialize(preferences: string): EpubPreferences | null {
+    try {
+      const parsedPreferences = JSON.parse(preferences);
+      return new EpubPreferences(parsedPreferences);
+    } catch (error) {
+      console.error("Failed to deserialize preferences:", error);
+      return null;
+    }
+  }
+
+  merging(other: ConfigurablePreferences): ConfigurablePreferences {
+    const merged: IEpubPreferences = { ...this };
+    for (const key of Object.keys(other) as (keyof IEpubPreferences)[]) {
+      if (
+        other[key] !== undefined &&
+        (
+          key !== "maximalLineLength" ||
+          other[key] === null ||
+          (other[key] >= (other.optimalLineLength ?? merged.optimalLineLength ?? 65))
+        ) &&
+        (
+          key !== "minimalLineLength" ||
+          other[key] === null || 
+          (other[key] <= (other.optimalLineLength ?? merged.optimalLineLength ?? 65))
+        )
+      ) {
+        merged[key] = other[key];
+      }
+    }
+    return new EpubPreferences(merged);
+  }
+}