@readium/navigator 2.0.0-beta.4 → 2.0.0-beta.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/navigator",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.6",
   "type": "module",
   "description": "Next generation SDK for publications in Web Apps",
   "author": "readium",
@@ -49,7 +49,7 @@
   },
   "devDependencies": {
     "@laynezh/vite-plugin-lib-assets": "^0.5.25",
-    "@readium/css": ">=2.0.0-beta.13",
+    "@readium/css": ">=2.0.0-beta.14",
     "@readium/navigator-html-injectables": "workspace:*",
     "@readium/shared": "workspace:*",
     "@types/path-browserify": "^1.0.3",
@@ -58,6 +58,7 @@
     "tslib": "^2.8.1",
     "typescript": "^5.6.3",
     "typescript-plugin-css-modules": "^5.1.0",
+    "user-agent-data-types": "^0.4.2",
     "vite": "^4.5.5"
   }
 }

package/src/epub/css/Properties.ts

@@ -60,7 +60,6 @@ export interface IUserProperties {
   deprecatedFontSize?: boolean | null;
   fontFamily?: string | null;
   fontOpticalSizing?: FontOpticalSizing | null;
-  fontOverride?: boolean | null;
   fontSize?: number | null;
   fontSizeNormalize?: boolean | null;
   fontWeight?: number | null;
@@ -96,7 +95,6 @@ export class UserProperties extends Properties {
   deprecatedFontSize: boolean | null;
   fontFamily: string | null;
   fontOpticalSizing: FontOpticalSizing | null;
-  fontOverride: boolean | null;
   fontSize: number | null;
   fontSizeNormalize: boolean | null;
   fontWeight: number | null;
@@ -132,7 +130,6 @@ export class UserProperties extends Properties {
     this.deprecatedFontSize = props.deprecatedFontSize ?? null;
     this.fontFamily = props.fontFamily ?? null;
     this.fontOpticalSizing = props.fontOpticalSizing ?? null;
-    this.fontOverride = props.fontOverride ?? null;
     this.fontSize = props.fontSize ?? null;
     this.fontSizeNormalize = props.fontSizeNormalize ?? null;
     this.fontWeight = props.fontWeight ?? null;
@@ -174,7 +171,6 @@ export class UserProperties extends Properties {
     if (this.deprecatedFontSize) cssProperties["--USER__fontSizeImplementation"] = this.toFlag("deprecatedFontSize");
     if (this.fontFamily) cssProperties["--USER__fontFamily"] = this.fontFamily;
     if (this.fontOpticalSizing != null) cssProperties["--USER__fontOpticalSizing"] = this.fontOpticalSizing;
-    if (this.fontOverride) cssProperties["--USER__fontOverride"] = this.toFlag("font");
     if (this.fontSize != null) cssProperties["--USER__fontSize"] = this.toPercentage(this.fontSize, true);
     if (this.fontSizeNormalize) cssProperties["--USER__fontSizeNormalize"] = this.toFlag("normalize");
     if (this.fontWeight != null) cssProperties["--USER__fontWeight"] = this.toUnitless(this.fontWeight);
@@ -234,6 +230,7 @@ export interface IRSProperties {
   maxMediaHeight?: number | null;
   modernTf?: string | null;
   monospaceTf?: string | null;
+  noOverflow?: boolean | null;
   noVerticalPagination?: boolean | null;
   oldStyleTf?: string | null;
   pageGutter?: number | null;
@@ -273,6 +270,7 @@ export class RSProperties extends Properties {
   maxMediaHeight: number | null;
   modernTf: string | null;
   monospaceTf: string | null;
+  noOverflow: boolean | null;
   noVerticalPagination: boolean | null;
   oldStyleTf: string | null;
   pageGutter: number | null;
@@ -312,6 +310,7 @@ export class RSProperties extends Properties {
     this.maxMediaHeight = props.maxMediaHeight ?? null;
     this.modernTf = props.modernTf ?? null;
     this.monospaceTf = props.monospaceTf ?? null;
+    this.noOverflow = props.noOverflow ?? null;
     this.noVerticalPagination = props.noVerticalPagination ?? null;
     this.oldStyleTf = props.oldStyleTf ?? null;
     this.pageGutter = props.pageGutter ?? null;
@@ -353,6 +352,7 @@ export class RSProperties extends Properties {
     if (this.maxMediaHeight) cssProperties["--RS__maxMediaHeight"] = this.toVh(this.maxMediaHeight);
     if (this.modernTf) cssProperties["--RS__modernTf"] = this.modernTf;
     if (this.monospaceTf) cssProperties["--RS__monospaceTf"] = this.monospaceTf;
+    if (this.noOverflow) cssProperties["--RS__disableOverflow"] = this.toFlag("noOverflow");
     if (this.noVerticalPagination) cssProperties["--RS__disablePagination"] = this.toFlag("noVerticalPagination");
     if (this.oldStyleTf) cssProperties["--RS__oldStyleTf"] = this.oldStyleTf;
     if (this.pageGutter != null) cssProperties["--RS__pageGutter"] = this.toPx(this.pageGutter);

package/src/epub/css/ReadiumCSS.ts

@@ -85,12 +85,6 @@ export class ReadiumCSS {
         : settings.fontOpticalSizing 
           ? "auto" 
           : "none",
-      fontOverride: settings.fontOverride !== null 
-        ? settings.fontOverride 
-        : (settings.textNormalization || settings.fontFamily 
-          ? true 
-          : false
-        ),
       fontSize: settings.fontSize,
       fontSizeNormalize: settings.fontSizeNormalize,
       fontWeight: settings.fontWeight,

package/src/epub/preferences/EpubDefaults.ts

@@ -32,7 +32,6 @@ export interface IEpubDefaults {
   fontSize?: number | null,
   fontSizeNormalize?: boolean | null,
   fontOpticalSizing?: boolean | null,
-  fontOverride?: boolean | null,
   fontWeight?: number | null,
   fontWidth?: number | null,
   hyphens?: boolean | null,
@@ -73,7 +72,6 @@ export class EpubDefaults {
   fontSize: number | null;
   fontSizeNormalize: boolean | null;
   fontOpticalSizing: boolean | null;
-  fontOverride: boolean | null;
   fontWeight: number | null;
   fontWidth: number | null;
   hyphens: boolean | null;
@@ -116,7 +114,6 @@ export class EpubDefaults {
     this.fontSize = ensureValueInRange(defaults.fontSize, fontSizeRangeConfig.range) || 1;
     this.fontSizeNormalize = ensureBoolean(defaults.fontSizeNormalize) ?? false;
     this.fontOpticalSizing = ensureBoolean(defaults.fontOpticalSizing) ?? null;
-    this.fontOverride = ensureBoolean(defaults.fontOverride) ?? null;
     this.fontWeight = ensureValueInRange(defaults.fontWeight, fontWeightRangeConfig.range) || null;
     this.fontWidth = ensureValueInRange(defaults.fontWidth,fontWidthRangeConfig.range) || null;
     this.hyphens = ensureBoolean(defaults.hyphens) ?? null;

package/src/epub/preferences/EpubPreferences.ts

@@ -29,7 +29,6 @@ export interface IEpubPreferences {
   fontSize?: number | null,
   fontSizeNormalize?: boolean | null,
   fontOpticalSizing?: boolean | null,
-  fontOverride?: boolean | null,
   fontWeight?: number | null,
   fontWidth?: number | null,
   hyphens?: boolean | null,
@@ -70,7 +69,6 @@ export class EpubPreferences implements ConfigurablePreferences {
   fontSize?: number | null;
   fontSizeNormalize?: boolean | null;
   fontOpticalSizing?: boolean | null;
-  fontOverride?: boolean | null;
   fontWeight?: number | null;
   fontWidth?: number | null;
   hyphens?: boolean | null;
@@ -110,7 +108,6 @@ export class EpubPreferences implements ConfigurablePreferences {
     this.fontSize = ensureValueInRange(preferences.fontSize, fontSizeRangeConfig.range);
     this.fontSizeNormalize = ensureBoolean(preferences.fontSizeNormalize);
     this.fontOpticalSizing = ensureBoolean(preferences.fontOpticalSizing);
-    this.fontOverride = ensureBoolean(preferences.fontOverride);
     this.fontWeight = ensureValueInRange(preferences.fontWeight, fontWeightRangeConfig.range);
     this.fontWidth = ensureValueInRange(preferences.fontWidth,fontWidthRangeConfig.range);
     this.hyphens = ensureBoolean(preferences.hyphens);

package/src/epub/preferences/EpubPreferencesEditor.ts

@@ -12,7 +12,7 @@ import {
   fontWidthRangeConfig 
 } from "../../preferences/Types";
 
-import dayMode from "@readium/css/css/vars/day.json";
+import defaultColors from "@readium/css/css/vars/day.json";
 
 // WIP: will change cos’ of all the missing pieces
 export class EpubPreferencesEditor implements IPreferencesEditor {
@@ -39,7 +39,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get backgroundColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.backgroundColor,
-      effectiveValue: this.settings.backgroundColor || dayMode.RS__backgroundColor,
+      effectiveValue: this.settings.backgroundColor || defaultColors.RS__backgroundColor,
       isEffective: this.preferences.backgroundColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("backgroundColor", newValue || null);
@@ -149,17 +149,6 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
     });
   }
 
-  get fontOverride(): BooleanPreference {
-    return new BooleanPreference({
-      initialValue: this.preferences.fontOverride,
-      effectiveValue: this.settings.fontOverride || false,
-      isEffective: this.layout === EPUBLayout.reflowable && this.preferences.fontOverride !== null,
-      onChange: (newValue: boolean | null | undefined) => {
-        this.updatePreference("fontOverride", newValue || null);
-      }
-    });
-  }
-
   get fontWeight(): RangePreference<number> {
     return new RangePreference<number>({
       initialValue: this.preferences.fontWeight,
@@ -288,7 +277,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get linkColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.linkColor,
-      effectiveValue: this.settings.linkColor || dayMode.RS__linkColor,
+      effectiveValue: this.settings.linkColor || defaultColors.RS__linkColor,
       isEffective: this.layout === EPUBLayout.reflowable && this.preferences.linkColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("linkColor", newValue || null);
@@ -397,7 +386,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get selectionBackgroundColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.selectionBackgroundColor,
-      effectiveValue: this.settings.selectionBackgroundColor || dayMode.RS__selectionBackgroundColor,
+      effectiveValue: this.settings.selectionBackgroundColor || defaultColors.RS__selectionBackgroundColor,
       isEffective: this.layout === EPUBLayout.reflowable && this.preferences.selectionBackgroundColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("selectionBackgroundColor", newValue || null);
@@ -408,7 +397,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get selectionTextColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.selectionTextColor,
-      effectiveValue: this.settings.selectionTextColor || dayMode.RS__selectionTextColor,
+      effectiveValue: this.settings.selectionTextColor || defaultColors.RS__selectionTextColor,
       isEffective: this.layout === EPUBLayout.reflowable && this.preferences.selectionTextColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("selectionTextColor", newValue || null);
@@ -431,7 +420,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get textColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.textColor,
-      effectiveValue: this.settings.textColor || dayMode.RS__textColor,
+      effectiveValue: this.settings.textColor || defaultColors.RS__textColor,
       isEffective: this.layout === EPUBLayout.reflowable && this.preferences.textColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("textColor", newValue || null);
@@ -453,7 +442,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get theme(): EnumPreference<Theme> {
     return new EnumPreference<Theme>({
       initialValue: this.preferences.theme,
-      effectiveValue: this.settings.theme || Theme.day,
+      effectiveValue: this.settings.theme || null,
       isEffective: this.layout === EPUBLayout.reflowable,
       onChange: (newValue: Theme | null | undefined) => {
         this.updatePreference("theme", newValue || null);
@@ -465,7 +454,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get visitedColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.visitedColor,
-      effectiveValue: this.settings.visitedColor || dayMode.RS__visitedColor,
+      effectiveValue: this.settings.visitedColor || defaultColors.RS__visitedColor,
       isEffective: this.layout === EPUBLayout.reflowable && this.preferences.visitedColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("visitedColor", newValue || null);

package/src/epub/preferences/EpubSettings.ts

@@ -16,7 +16,6 @@ export interface IEpubSettings {
   fontSize?: number | null,
   fontSizeNormalize?: boolean | null,
   fontOpticalSizing?: boolean | null,
-  fontOverride?: boolean | null,
   fontWeight?: number | null,
   fontWidth?: number | null,
   hyphens?: boolean | null,
@@ -57,7 +56,6 @@ export class EpubSettings implements ConfigurableSettings {
   fontSize: number | null;
   fontSizeNormalize: boolean | null;
   fontOpticalSizing: boolean | null;
-  fontOverride: boolean | null;
   fontWeight: number | null;
   fontWidth: number | null;
   hyphens: boolean | null;
@@ -115,9 +113,6 @@ export class EpubSettings implements ConfigurableSettings {
     this.fontOpticalSizing = typeof preferences.fontOpticalSizing === "boolean" 
       ? preferences.fontOpticalSizing 
       : defaults.fontOpticalSizing ?? null;
-    this.fontOverride = typeof preferences.fontOverride === "boolean" 
-      ? preferences.fontOverride 
-      : defaults.fontOverride ?? null;
     this.fontWeight = preferences.fontWeight !== undefined 
       ? preferences.fontWeight 
       : defaults.fontWeight !== undefined 

package/src/helpers/sML.ts

@@ -8,6 +8,7 @@
  * Portions of this code come from the sML library
  * Current version: 1.0.36
  */
+/// <reference types="user-agent-data-types" />
 
 declare interface OSFlags {
     iOS: number[];
@@ -46,13 +47,17 @@ declare interface UAFlags {
 
 declare type iOSRequest = "mobile" | "desktop" | undefined;
 
+// Fallback when global 'navigator' is not available, such as in SSR environments.
+const userAgent = () => typeof navigator === "undefined" ? "" : (navigator.userAgent || "");
+const userAgentData = () => typeof navigator === "undefined" ? undefined : (navigator.userAgentData || undefined);
+
 class sMLFactory {
     OS: OSFlags;
     UA: UAFlags;
     Env!: string[];
 
     constructor() {
-        const NUAD = (navigator as any).userAgentData, NUA = navigator.userAgent;
+        const NUAD = userAgentData(), NUA = userAgent();
 
         const _sV = (V?: string | number) => (typeof V === "string" || typeof V === "number") && V ? String(V).replace(/_/g, ".").split(".").map(I => parseInt(I) || 0) : [];
         const _dV = (Pre="") => {
@@ -84,7 +89,7 @@ class sMLFactory {
         })({} as OSFlags));
 
         this.UA = ((UA: UAFlags) => { let _OK = false;
-            if(NUAD && Array.isArray(NUAD.brands)) { const BnV = NUAD.brands.reduce((BnV: string[], _: any) => { (BnV[_.brand] as any) = [_.version * 1]; return BnV; }, {});
+            if(NUAD && Array.isArray(NUAD.brands)) { const BnV = NUAD.brands.reduce((BnV: Record<string, number[]>, _: NavigatorUABrandVersion) => { BnV[_.brand] = [(_.version as any) * 1]; return BnV; }, {});
                     if(BnV["Google Chrome"])  _OK = true, UA.Blink = UA.Chromium = BnV["Chromium"] || [], UA.Chrome = BnV["Google Chrome"];
                 else if(BnV["Microsoft Edge"]) _OK = true, UA.Blink = UA.Chromium = BnV["Chromium"] || [], UA.Edge = BnV["Microsoft Edge"];
                 else if(BnV["Opera"])          _OK = true, UA.Blink = UA.Chromium = BnV["Chromium"] || [], UA.Opera = BnV["Opera"];
@@ -121,7 +126,7 @@ class sMLFactory {
 
 class sMLFactoryWithRequest extends sMLFactory {
     get iOSRequest(): iOSRequest {
-        const NUAD = (navigator as any).userAgentData, NUA = navigator.userAgent;
+        const NUAD = userAgentData(), NUA = userAgent();
 
         if (this.OS.iOS && !this.OS.iPadOS) {
             return "mobile";

package/src/preferences/Types.ts

@@ -6,7 +6,6 @@ export enum TextAlignment {
 };
 
 export enum Theme {
-  day = "day",
   sepia = "sepia",
   night = "night",
   custom = "custom"

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

@@ -31,7 +31,6 @@ export interface IUserProperties {
     deprecatedFontSize?: boolean | null;
     fontFamily?: string | null;
     fontOpticalSizing?: FontOpticalSizing | null;
-    fontOverride?: boolean | null;
     fontSize?: number | null;
     fontSizeNormalize?: boolean | null;
     fontWeight?: number | null;
@@ -66,7 +65,6 @@ export declare class UserProperties extends Properties {
     deprecatedFontSize: boolean | null;
     fontFamily: string | null;
     fontOpticalSizing: FontOpticalSizing | null;
-    fontOverride: boolean | null;
     fontSize: number | null;
     fontSizeNormalize: boolean | null;
     fontWeight: number | null;
@@ -114,6 +112,7 @@ export interface IRSProperties {
     maxMediaHeight?: number | null;
     modernTf?: string | null;
     monospaceTf?: string | null;
+    noOverflow?: boolean | null;
     noVerticalPagination?: boolean | null;
     oldStyleTf?: string | null;
     pageGutter?: number | null;
@@ -152,6 +151,7 @@ export declare class RSProperties extends Properties {
     maxMediaHeight: number | null;
     modernTf: string | null;
     monospaceTf: string | null;
+    noOverflow: boolean | null;
     noVerticalPagination: boolean | null;
     oldStyleTf: string | null;
     pageGutter: number | null;

package/types/src/epub/preferences/EpubDefaults.d.ts

@@ -10,7 +10,6 @@ export interface IEpubDefaults {
     fontSize?: number | null;
     fontSizeNormalize?: boolean | null;
     fontOpticalSizing?: boolean | null;
-    fontOverride?: boolean | null;
     fontWeight?: number | null;
     fontWidth?: number | null;
     hyphens?: boolean | null;
@@ -50,7 +49,6 @@ export declare class EpubDefaults {
     fontSize: number | null;
     fontSizeNormalize: boolean | null;
     fontOpticalSizing: boolean | null;
-    fontOverride: boolean | null;
     fontWeight: number | null;
     fontWidth: number | null;
     hyphens: boolean | null;

package/types/src/epub/preferences/EpubPreferences.d.ts

@@ -11,7 +11,6 @@ export interface IEpubPreferences {
     fontSize?: number | null;
     fontSizeNormalize?: boolean | null;
     fontOpticalSizing?: boolean | null;
-    fontOverride?: boolean | null;
     fontWeight?: number | null;
     fontWidth?: number | null;
     hyphens?: boolean | null;
@@ -51,7 +50,6 @@ export declare class EpubPreferences implements ConfigurablePreferences {
     fontSize?: number | null;
     fontSizeNormalize?: boolean | null;
     fontOpticalSizing?: boolean | null;
-    fontOverride?: boolean | null;
     fontWeight?: number | null;
     fontWidth?: number | null;
     hyphens?: boolean | null;

package/types/src/epub/preferences/EpubPreferencesEditor.d.ts

@@ -22,7 +22,6 @@ export declare class EpubPreferencesEditor implements IPreferencesEditor {
     get fontSize(): RangePreference<number>;
     get fontSizeNormalize(): BooleanPreference;
     get fontOpticalSizing(): BooleanPreference;
-    get fontOverride(): BooleanPreference;
     get fontWeight(): RangePreference<number>;
     get fontWidth(): RangePreference<number>;
     get hyphens(): BooleanPreference;

package/types/src/epub/preferences/EpubSettings.d.ts

@@ -13,7 +13,6 @@ export interface IEpubSettings {
     fontSize?: number | null;
     fontSizeNormalize?: boolean | null;
     fontOpticalSizing?: boolean | null;
-    fontOverride?: boolean | null;
     fontWeight?: number | null;
     fontWidth?: number | null;
     hyphens?: boolean | null;
@@ -53,7 +52,6 @@ export declare class EpubSettings implements ConfigurableSettings {
     fontSize: number | null;
     fontSizeNormalize: boolean | null;
     fontOpticalSizing: boolean | null;
-    fontOverride: boolean | null;
     fontWeight: number | null;
     fontWidth: number | null;
     hyphens: boolean | null;

package/types/src/preferences/Types.d.ts

@@ -5,7 +5,6 @@ export declare enum TextAlignment {
     justify = "justify"
 }
 export declare enum Theme {
-    day = "day",
     sepia = "sepia",
     night = "night",
     custom = "custom"