@readium/navigator 2.2.3 → 2.2.5

package/src/webpub/preferences/WebPubPreferencesEditor.ts

@@ -74,6 +74,28 @@ export class WebPubPreferencesEditor implements IPreferencesEditor {
     });
   }
 
+  get iOSPatch(): BooleanPreference {
+      return new BooleanPreference({
+        initialValue: this.preferences.iOSPatch,
+        effectiveValue: this.settings.iOSPatch || false,
+        isEffective: true,
+        onChange: (newValue: boolean | null | undefined) => {
+          this.updatePreference("iOSPatch", newValue || null);
+        }
+      });
+    }
+  
+    get iPadOSPatch(): BooleanPreference {
+      return new BooleanPreference({
+        initialValue: this.preferences.iPadOSPatch,
+        effectiveValue: this.settings.iPadOSPatch || false,
+        isEffective: true,
+        onChange: (newValue: boolean | null | undefined) => {
+          this.updatePreference("iPadOSPatch", newValue || null);
+        }
+      });
+    }
+
   get letterSpacing(): RangePreference<number> {
     return new RangePreference<number>({
       initialValue: this.preferences.letterSpacing,

package/src/webpub/preferences/WebPubSettings.ts

@@ -1,12 +1,16 @@
 import { ConfigurableSettings } from "../../preferences/Configurable";
-import { TextAlignment } from "../../preferences/Types";
+import { ExperimentKey, TextAlignment } from "../../preferences/Types";
 import { WebPubDefaults } from "./WebPubDefaults";
 import { WebPubPreferences } from "./WebPubPreferences";
 
+import { sMLWithRequest } from "../../helpers";
+
 export interface IWebPubSettings {
   fontFamily?: string | null,
   fontWeight?: number | null,
   hyphens?: boolean | null,
+  iOSPatch?: boolean | null,
+  iPadOSPatch?: boolean | null,
   letterSpacing?: number | null,
   ligatures?: boolean | null,
   lineHeight?: number | null,
@@ -16,13 +20,16 @@ export interface IWebPubSettings {
   textAlign?: TextAlignment | null,
   textNormalization?: boolean | null,
   wordSpacing?: number | null,
-  zoom?: number | null;
+  zoom?: number | null,
+  experiments?: Array<ExperimentKey> | null,
 }
 
 export class WebPubSettings implements ConfigurableSettings {
   fontFamily: string | null = null;
   fontWeight: number | null = null;
   hyphens: boolean | null = null;
+  iOSPatch: boolean | null = null;
+  iPadOSPatch: boolean | null = null;
   letterSpacing: number | null = null;
   ligatures: boolean | null = null;
   lineHeight: number | null = null;
@@ -33,6 +40,7 @@ export class WebPubSettings implements ConfigurableSettings {
   textNormalization: boolean | null = null;
   wordSpacing: number | null = null;
   zoom: number | null;
+  experiments: Array<ExperimentKey> | null;
 
   constructor(preferences: WebPubPreferences, defaults: WebPubDefaults, hasDisplayTransformability: boolean) {
     if (hasDisplayTransformability) {
@@ -45,6 +53,16 @@ export class WebPubSettings implements ConfigurableSettings {
       this.hyphens = typeof preferences.hyphens === "boolean" 
         ? preferences.hyphens 
         : defaults.hyphens ?? null;
+      this.iOSPatch = preferences.iOSPatch === false 
+        ? false 
+        : preferences.iOSPatch === true 
+          ? ((sMLWithRequest.OS.iOS || sMLWithRequest.OS.iPadOS) && sMLWithRequest.iOSRequest === "mobile")
+          : defaults.iOSPatch;
+      this.iPadOSPatch = preferences.iPadOSPatch === false 
+        ? false 
+        : preferences.iPadOSPatch === true 
+          ? (sMLWithRequest.OS.iPadOS && sMLWithRequest.iOSRequest === "desktop") 
+          : defaults.iPadOSPatch;
       this.letterSpacing = preferences.letterSpacing !== undefined 
         ? preferences.letterSpacing 
         : defaults.letterSpacing !== undefined 
@@ -81,10 +99,13 @@ export class WebPubSettings implements ConfigurableSettings {
           ? defaults.wordSpacing 
           : null;
     }
+    
     this.zoom = preferences.zoom !== undefined
       ? preferences.zoom
       : defaults.zoom !== undefined
         ? defaults.zoom
         : null;
+
+    this.experiments = defaults.experiments || null;
   }
 }

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

@@ -1,4 +1,4 @@
-import { TextAlignment } from "../../preferences/Types";
+import { ExperimentKey, TextAlignment } from "../../preferences/Types";
 import { BodyHyphens, BoxSizing, FontOpticalSizing, FontWidth, Ligatures, Properties, TypeScale, View } from "../../css/Properties";
 export interface IUserProperties {
     advancedSettings?: boolean | null;
@@ -113,6 +113,7 @@ export interface IRSProperties {
     textColor?: string | null;
     typeScale?: TypeScale | null;
     visitedColor?: string | null;
+    experiments?: Array<ExperimentKey> | null;
 }
 export declare class RSProperties extends Properties {
     backgroundColor: string | null;
@@ -154,6 +155,7 @@ export declare class RSProperties extends Properties {
     textColor: string | null;
     typeScale: TypeScale | null;
     visitedColor: string | null;
+    experiments: Array<ExperimentKey> | null;
     constructor(props: IRSProperties);
     toCSSProperties(): {
         [key: string]: string;

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

@@ -1,4 +1,4 @@
-import { TextAlignment } from "../../preferences/Types";
+import { ExperimentKey, TextAlignment } from "../../preferences/Types";
 export interface IEpubDefaults {
     backgroundColor?: string | null;
     blendFilter?: boolean | null;
@@ -38,6 +38,7 @@ export interface IEpubDefaults {
     textNormalization?: boolean | null;
     visitedColor?: string | null;
     wordSpacing?: number | null;
+    experiments?: Array<ExperimentKey> | null;
 }
 export declare class EpubDefaults {
     backgroundColor: string | null;
@@ -78,5 +79,6 @@ export declare class EpubDefaults {
     textNormalization: boolean | null;
     visitedColor: string | null;
     wordSpacing: number | null;
+    experiments: Array<ExperimentKey> | null;
     constructor(defaults: IEpubDefaults);
 }

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

@@ -1,5 +1,5 @@
 import { ConfigurableSettings } from "../../preferences/Configurable";
-import { TextAlignment } from "../../preferences/Types";
+import { ExperimentKey, TextAlignment } from "../../preferences/Types";
 import { EpubDefaults } from "./EpubDefaults";
 import { EpubPreferences } from "./EpubPreferences";
 export interface IEpubSettings {
@@ -41,6 +41,7 @@ export interface IEpubSettings {
     textNormalization?: boolean | null;
     visitedColor?: string | null;
     wordSpacing?: number | null;
+    experiments?: Array<ExperimentKey> | null;
 }
 export declare class EpubSettings implements ConfigurableSettings {
     backgroundColor: string | null;
@@ -81,5 +82,6 @@ export declare class EpubSettings implements ConfigurableSettings {
     textNormalization: boolean | null;
     visitedColor: string | null;
     wordSpacing: number | null;
+    experiments: Array<ExperimentKey> | null;
     constructor(preferences: EpubPreferences, defaults: EpubDefaults);
 }

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

@@ -1,3 +1,17 @@
+import RCSSExperiments from "@readium/css/css/vars/experiments.json";
+export type ExperimentKey = keyof typeof RCSSExperiments;
+export declare const experiments: {
+    experimentalHeaderFiltering: {
+        description: string;
+        scope: string;
+        value: string;
+    };
+    experimentalZoom: {
+        description: string;
+        scope: string;
+        value: string;
+    };
+};
 export declare enum TextAlignment {
     start = "start",
     left = "left",

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

@@ -1,3 +1,4 @@
+import { ExperimentKey } from './Types';
 export declare function ensureLessThanOrEqual<T extends number | null | undefined>(value: T, compareTo: T): T | undefined;
 export declare function ensureMoreThanOrEqual<T extends number | null | undefined>(value: T, compareTo: T): T | undefined;
 export declare function ensureString(value: string | null | undefined): string | null | undefined;
@@ -7,3 +8,4 @@ export declare function ensureFilter(filter: boolean | number | null | undefined
 export declare function ensureNonNegative(value: number | null | undefined): number | null | undefined;
 export declare function ensureValueInRange(value: number | null | undefined, range: [number, number]): number | null | undefined;
 export declare function withFallback<T>(value: T | null | undefined, defaultValue: T | null): T | null;
+export declare function ensureExperiment(experimentsInput: ExperimentKey[] | null | undefined): ExperimentKey[] | null | undefined;

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

@@ -1,10 +1,12 @@
-import { TextAlignment } from "../../preferences/Types";
+import { ExperimentKey, TextAlignment } from "../../preferences/Types";
 import { BodyHyphens, Ligatures, Properties } from "../../css/Properties";
 export interface IWebUserProperties {
     a11yNormalize?: boolean | null;
     bodyHyphens?: BodyHyphens | null;
     fontFamily?: string | null;
     fontWeight?: number | null;
+    iOSPatch?: boolean | null;
+    iPadOSPatch?: boolean | null;
     letterSpacing?: number | null;
     ligatures?: Ligatures | null;
     lineHeight?: number | null;
@@ -20,6 +22,8 @@ export declare class WebUserProperties extends Properties {
     bodyHyphens: BodyHyphens | null;
     fontFamily: string | null;
     fontWeight: number | null;
+    iOSPatch: boolean | null;
+    iPadOSPatch: boolean | null;
     letterSpacing: number | null;
     ligatures: Ligatures | null;
     lineHeight: number | null;
@@ -34,3 +38,13 @@ export declare class WebUserProperties extends Properties {
         [key: string]: string;
     };
 }
+export interface IWebRSProperties {
+    experiments: Array<ExperimentKey> | null;
+}
+export declare class WebRSProperties extends Properties {
+    experiments: Array<ExperimentKey> | null;
+    constructor(props: IWebRSProperties);
+    toCSSProperties(): {
+        [key: string]: string;
+    };
+}

package/types/src/webpub/css/WebPubCSS.d.ts

@@ -1,9 +1,11 @@
 import { WebPubSettings } from "../preferences/WebPubSettings";
-import { WebUserProperties } from "./Properties";
+import { WebRSProperties, WebUserProperties } from "./Properties";
 export interface IWebPubCSS {
+    rsProperties: WebRSProperties;
     userProperties: WebUserProperties;
 }
 export declare class WebPubCSS {
+    rsProperties: WebRSProperties;
     userProperties: WebUserProperties;
     constructor(props: IWebPubCSS);
     update(settings: WebPubSettings): void;

package/types/src/webpub/css/index.d.ts

@@ -1,3 +1,2 @@
 export * from "./Properties";
 export * from "./WebPubCSS";
-export * from "./WebPubStylesheet";

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

@@ -1,8 +1,10 @@
-import { TextAlignment } from "../../preferences/Types";
+import { ExperimentKey, TextAlignment } from "../../preferences/Types";
 export interface IWebPubDefaults {
     fontFamily?: string | null;
     fontWeight?: number | null;
     hyphens?: boolean | null;
+    iOSPatch?: boolean | null;
+    iPadOSPatch?: boolean | null;
     letterSpacing?: number | null;
     ligatures?: boolean | null;
     lineHeight?: number | null;
@@ -13,11 +15,14 @@ export interface IWebPubDefaults {
     textNormalization?: boolean | null;
     wordSpacing?: number | null;
     zoom?: number | null;
+    experiments?: Array<ExperimentKey> | null;
 }
 export declare class WebPubDefaults {
     fontFamily: string | null;
     fontWeight: number | null;
     hyphens: boolean | null;
+    iOSPatch: boolean | null;
+    iPadOSPatch: boolean | null;
     letterSpacing: number | null;
     ligatures: boolean | null;
     lineHeight: number | null;
@@ -28,5 +33,6 @@ export declare class WebPubDefaults {
     textNormalization: boolean | null;
     wordSpacing: number | null;
     zoom: number;
+    experiments: Array<ExperimentKey> | null;
     constructor(defaults: IWebPubDefaults);
 }

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

@@ -4,6 +4,8 @@ export interface IWebPubPreferences {
     fontFamily?: string | null;
     fontWeight?: number | null;
     hyphens?: boolean | null;
+    iOSPatch?: boolean | null;
+    iPadOSPatch?: boolean | null;
     letterSpacing?: number | null;
     ligatures?: boolean | null;
     lineHeight?: number | null;
@@ -19,6 +21,8 @@ export declare class WebPubPreferences implements ConfigurablePreferences {
     fontFamily?: string | null;
     fontWeight?: number | null;
     hyphens?: boolean | null;
+    iOSPatch?: boolean | null;
+    iPadOSPatch?: boolean | null;
     letterSpacing?: number | null;
     ligatures?: boolean | null;
     lineHeight?: number | null;

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

@@ -15,6 +15,8 @@ export declare class WebPubPreferencesEditor implements IPreferencesEditor {
     get fontFamily(): Preference<string>;
     get fontWeight(): RangePreference<number>;
     get hyphens(): BooleanPreference;
+    get iOSPatch(): BooleanPreference;
+    get iPadOSPatch(): BooleanPreference;
     get letterSpacing(): RangePreference<number>;
     get ligatures(): BooleanPreference;
     get lineHeight(): RangePreference<number>;

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

@@ -1,11 +1,13 @@
 import { ConfigurableSettings } from "../../preferences/Configurable";
-import { TextAlignment } from "../../preferences/Types";
+import { ExperimentKey, TextAlignment } from "../../preferences/Types";
 import { WebPubDefaults } from "./WebPubDefaults";
 import { WebPubPreferences } from "./WebPubPreferences";
 export interface IWebPubSettings {
     fontFamily?: string | null;
     fontWeight?: number | null;
     hyphens?: boolean | null;
+    iOSPatch?: boolean | null;
+    iPadOSPatch?: boolean | null;
     letterSpacing?: number | null;
     ligatures?: boolean | null;
     lineHeight?: number | null;
@@ -16,11 +18,14 @@ export interface IWebPubSettings {
     textNormalization?: boolean | null;
     wordSpacing?: number | null;
     zoom?: number | null;
+    experiments?: Array<ExperimentKey> | null;
 }
 export declare class WebPubSettings implements ConfigurableSettings {
     fontFamily: string | null;
     fontWeight: number | null;
     hyphens: boolean | null;
+    iOSPatch: boolean | null;
+    iPadOSPatch: boolean | null;
     letterSpacing: number | null;
     ligatures: boolean | null;
     lineHeight: number | null;
@@ -31,5 +36,6 @@ export declare class WebPubSettings implements ConfigurableSettings {
     textNormalization: boolean | null;
     wordSpacing: number | null;
     zoom: number | null;
+    experiments: Array<ExperimentKey> | null;
     constructor(preferences: WebPubPreferences, defaults: WebPubDefaults, hasDisplayTransformability: boolean);
 }

package/src/webpub/css/WebPubStylesheet.ts

@@ -1,205 +0,0 @@
-// WebPubCSS is equivalent to ReadiumCSS for WebPub
-// Respects the stylesheet order from after
-
-export const webPubStylesheet = `
-/* TextAlign */
-
-:root[style*="--USER__textAlign"] {
-  text-align: var(--USER__textAlign);
-}
-
-:root[style*="--USER__textAlign"] body,
-:root[style*="--USER__textAlign"] p:not([class*="title"]):not(blockquote p):not(figcaption p):not(header p):not(hgroup p):not(div:has(+ *) > h1 + p):not(div:has(+ *) > p:has(+ h1)),
-:root[style*="--USER__textAlign"] li,
-:root[style*="--USER__textAlign"] dd {
-  text-align: var(--USER__textAlign) !important;
-  -moz-text-align-last: auto !important;
-  -epub-text-align-last: auto !important;
-  text-align-last: auto !important;
-}
-
-/* Hyphens */
-
-:root[style*="--USER__bodyHyphens"] {
-  -webkit-hyphens: var(--USER__bodyHyphens) !important;
-  -moz-hyphens: var(--USER__bodyHyphens) !important;
-  -ms-hyphens: var(--USER__bodyHyphens) !important;
-  -epub-hyphens: var(--USER__bodyHyphens) !important;
-  hyphens: var(--USER__bodyHyphens) !important;
-}
-
-:root[style*="--USER__bodyHyphens"] body,
-:root[style*="--USER__bodyHyphens"] p,
-:root[style*="--USER__bodyHyphens"] li,
-:root[style*="--USER__bodyHyphens"] div,
-:root[style*="--USER__bodyHyphens"] dd {
-  -webkit-hyphens: inherit;
-  -moz-hyphens: inherit;
-  -ms-hyphens: inherit;
-  -epub-hyphens: inherit;
-  hyphens: inherit;
-}
-
-/* FontFamily */
-
-:root[style*="--USER__fontFamily"] {
-  font-family: var(--USER__fontFamily) !important;
-}
-
-:root[style*="--USER__fontFamily"] * {
-  font-family: revert !important;
-}
-
-/* TextNormalize */
-
-:root[style*="readium-a11y-on"] {
-  font-weight: normal !important;
-  font-style: normal !important;
-}
-
-:root[style*="readium-a11y-on"] body *:not(code):not(var):not(kbd):not(samp) {
-  font-family: inherit !important;
-  font-weight: inherit !important;
-  font-style: inherit !important;
-}
-
-:root[style*="readium-a11y-on"] body * {
-  text-decoration: none !important;
-  font-variant-caps: normal !important;
-  font-variant-position: normal !important;
-  font-variant-numeric: normal !important;
-}
-
-:root[style*="readium-a11y-on"] sup,
-:root[style*="readium-a11y-on"] sub {
-  font-size: 1rem !important;
-  vertical-align: baseline !important;
-}
-
-/* Zoom */
-
-:root {
-  --USER__zoom: 1;
-}
-
-:root[style*="--USER__zoom"] body {
-  zoom: var(--USER__zoom) !important;
-}
-
-@supports selector(figure:has(> img)) {
-  :root[style*="--USER__zoom"] figure:has(> img),
-  :root[style*="--USER__zoom"] figure:has(> video),
-  :root[style*="--USER__zoom"] figure:has(> svg),
-  :root[style*="--USER__zoom"] figure:has(> canvas),
-  :root[style*="--USER__zoom"] figure:has(> iframe),
-  :root[style*="--USER__zoom"] figure:has(> audio),
-  :root[style*="--USER__zoom"] div:has(> img),
-  :root[style*="--USER__zoom"] div:has(> video),
-  :root[style*="--USER__zoom"] div:has(> svg),
-  :root[style*="--USER__zoom"] div:has(> canvas),
-  :root[style*="--USER__zoom"] div:has(> iframe),
-  :root[style*="--USER__zoom"] div:has(> audio),
-  :root[style*="--USER__zoom"] table {
-    zoom: calc(100% / var(--USER__zoom)) !important;
-  }
-
-  :root[style*="--USER__zoom"] figcaption,
-  :root[style*="--USER__zoom"] caption,
-  :root[style*="--USER__zoom"] td,
-  :root[style*="--USER__zoom"] th {
-    zoom: var(--USER__zoom) !important;
-  }
-}
-
-/* LineHeight */
-
-:root[style*="--USER__lineHeight"] {
-  line-height: var(--USER__lineHeight) !important;
-}
-
-:root[style*="--USER__lineHeight"] body,
-:root[style*="--USER__lineHeight"] p,
-:root[style*="--USER__lineHeight"] li,
-:root[style*="--USER__lineHeight"] div {
-  line-height: inherit;
-}
-
-/* ParagraphSpacing */
-
-:root[style*="--USER__paraSpacing"] p {
-  margin-block: var(--USER__paraSpacing) !important;
-}
-
-/* ParagraphIndent */
-
-:root[style*="--USER__paraIndent"] p {
-  text-indent: var(--USER__paraIndent) !important;
-}
-
-:root[style*="--USER__paraIndent"] p *,
-:root[style*="--USER__paraIndent"] p:first-letter {
-  text-indent: 0 !important;
-}
-
-/* WordSpacing */
-
-:root[style*="--USER__wordSpacing"] h1,
-:root[style*="--USER__wordSpacing"] h2,
-:root[style*="--USER__wordSpacing"] h3,
-:root[style*="--USER__wordSpacing"] h4,
-:root[style*="--USER__wordSpacing"] h5,
-:root[style*="--USER__wordSpacing"] h6,
-:root[style*="--USER__wordSpacing"] p,
-:root[style*="--USER__wordSpacing"] li,
-:root[style*="--USER__wordSpacing"] div,
-:root[style*="--USER__wordSpacing"] dt,
-:root[style*="--USER__wordSpacing"] dd {
-  word-spacing: var(--USER__wordSpacing);
-}
-
-/* LetterSpacing */
-
-:root[style*="--USER__letterSpacing"] h1,
-:root[style*="--USER__letterSpacing"] h2,
-:root[style*="--USER__letterSpacing"] h3,
-:root[style*="--USER__letterSpacing"] h4,
-:root[style*="--USER__letterSpacing"] h5,
-:root[style*="--USER__letterSpacing"] h6,
-:root[style*="--USER__letterSpacing"] p,
-:root[style*="--USER__letterSpacing"] li,
-:root[style*="--USER__letterSpacing"] div,
-:root[style*="--USER__letterSpacing"] dt,
-:root[style*="--USER__letterSpacing"] dd {
-  letter-spacing: var(--USER__letterSpacing);
-  font-variant: none;
-}
-
-/* FontWeight */
-
-:root[style*="--USER__fontWeight"] body {
-  font-weight: var(--USER__fontWeight) !important;
-}
-
-/* Attempt to handle known bolds */
-:root[style*="--USER__fontWeight"] b,
-:root[style*="--USER__fontWeight"] strong {
-  font-weight: bolder;
-}
-
-/* Ruby */
-
-:root[style*="readium-noRuby-on"] body rt,
-:root[style*="readium-noRuby-on"] body rp {
-  display: none;
-}
-
-/* Ligatures */
-
-:root[style*="--USER__ligatures"] {
-  font-variant-ligatures: var(--USER__ligatures) !important;
-}
-
-:root[style*="--USER__ligatures"] * {
-  font-variant-ligatures: inherit !important;
-}
-`;