@readium/navigator 2.5.2-beta.5 → 2.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readium/navigator",
-  "version": "2.5.2-beta.5",
+  "version": "2.5.3",
   "type": "module",
   "description": "Next generation SDK for publications in Web Apps",
   "author": "readium",
@@ -50,7 +50,7 @@
     "generate:css-selector": "node scripts/generate-css-selector.js"
   },
   "devDependencies": {
-    "@readium/css": "^2.0.2",
+    "@readium/css": "^2.0.4",
     "@readium/navigator-html-injectables": "workspace:*",
     "@readium/shared": "workspace:*",
     "@types/path-browserify": "^1.0.3",

package/src/Navigator.ts

@@ -3,6 +3,7 @@ import {
     ContentProtectionConfig, 
     PrintProtectionConfig, 
     KeyboardPeripheral,
+    KeyboardPeripheralEvent,
     KeyCombo,
     DEV_TOOLS, 
     SELECT_ALL, 
@@ -12,6 +13,10 @@ import {
 
 type cbb = (ok: boolean) => void;
 
+export interface KeyboardPeripheralEventData extends Omit<KeyboardPeripheralEvent, 'interactiveElement'> {
+    interactiveElement?: Element;
+}
+
 export type IKeyboardPeripheralsConfig = Array<Omit<KeyboardPeripheral, 'type'> & {
     type: Exclude<string, 'developer_tools' | 'select_all' | 'print' | 'save'>;
 }>;

package/src/audio/AudioNavigator.ts

@@ -1,5 +1,5 @@
 import { Link, Locator, LocatorLocations, Publication, Timeline, TimelineItem } from "@readium/shared";
-import { MediaNavigator, IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator.ts";
+import { MediaNavigator, IContentProtectionConfig, IKeyboardPeripheralsConfig, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { WebAudioEngine, PlaybackState } from "./engine/index.ts";
 import {
@@ -11,7 +11,7 @@ import {
     IAudioDefaults
 } from "./preferences/index.ts";
 import { AudioPoolManager } from "./AudioPoolManager.ts";
-import { ContextMenuEvent, KeyboardEventData, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
+import { ContextMenuEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
 import { AudioNavigatorProtector } from "./protection/AudioNavigatorProtector.ts";
 import { NAVIGATOR_SUSPICIOUS_ACTIVITY_EVENT } from "../protection/NavigatorProtector.ts";
 import { KeyboardPeripherals, NAVIGATOR_KEYBOARD_PERIPHERAL_EVENT } from "../peripherals/KeyboardPeripherals.ts";
@@ -36,7 +36,7 @@ export interface AudioNavigatorListeners {
     seeking: (isSeeking: boolean) => void;
     seekable: (seekable: TimeRanges) => void;
     contentProtection: (type: string, data: SuspiciousActivityEvent) => void;
-    peripheral: (data: KeyboardEventData) => void;
+    peripheral: (data: KeyboardPeripheralEventData) => void;
     contextMenu: (data: ContextMenuEvent) => void;
     remotePlaybackStateChanged: (state: RemotePlaybackState) => void;
 }

package/src/epub/EpubNavigator.ts

@@ -16,17 +16,13 @@ import { getContentWidth } from "../helpers/dimensions.ts";
 import { Injector } from "../injection/Injector.ts";
 import { createReadiumEpubRules } from "../injection/epubInjectables.ts";
 import { IInjectableRule, IInjectablesConfig } from "../injection/Injectable.ts";
-import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator.ts";
+import { IContentProtectionConfig, IKeyboardPeripheralsConfig, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { NavigatorProtector, NAVIGATOR_SUSPICIOUS_ACTIVITY_EVENT } from "../protection/NavigatorProtector.ts";
 import { KeyboardPeripherals, NAVIGATOR_KEYBOARD_PERIPHERAL_EVENT } from "../peripherals/KeyboardPeripherals.ts";
 import { getScriptMode } from "../helpers/scriptMode.ts";
 
 export type ManagerEventKey = "zoom";
 
-export interface KeyboardPeripheralEventData extends Omit<KeyboardPeripheralEvent, 'interactiveElement'> {
-    interactiveElement?: Element;
-}
-
 export interface EpubNavigatorConfiguration {
     preferences: IEpubPreferences;
     defaults: IEpubDefaults;

package/src/epub/preferences/EpubPreferencesEditor.ts

@@ -44,7 +44,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get backgroundColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.backgroundColor,
-      effectiveValue: this.settings.backgroundColor || defaultColors.RS__backgroundColor,
+      effectiveValue: this.settings.backgroundColor || defaultColors.backgroundColor,
       isEffective: this.preferences.backgroundColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("backgroundColor", newValue ?? null);
@@ -302,7 +302,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get linkColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.linkColor,
-      effectiveValue: this.settings.linkColor || defaultColors.RS__linkColor,
+      effectiveValue: this.settings.linkColor || defaultColors.linkColor,
       isEffective: this.layout !== Layout.fixed && this.preferences.linkColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("linkColor", newValue ?? null);
@@ -455,7 +455,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get selectionBackgroundColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.selectionBackgroundColor,
-      effectiveValue: this.settings.selectionBackgroundColor || defaultColors.RS__selectionBackgroundColor,
+      effectiveValue: this.settings.selectionBackgroundColor || defaultColors.selectionBackgroundColor,
       isEffective: this.layout !== Layout.fixed && this.preferences.selectionBackgroundColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("selectionBackgroundColor", newValue ?? null);
@@ -466,7 +466,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get selectionTextColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.selectionTextColor,
-      effectiveValue: this.settings.selectionTextColor || defaultColors.RS__selectionTextColor,
+      effectiveValue: this.settings.selectionTextColor || defaultColors.selectionTextColor,
       isEffective: this.layout !== Layout.fixed && this.preferences.selectionTextColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("selectionTextColor", newValue ?? null);
@@ -489,7 +489,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get textColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.textColor,
-      effectiveValue: this.settings.textColor || defaultColors.RS__textColor,
+      effectiveValue: this.settings.textColor || defaultColors.textColor,
       isEffective: this.layout !== Layout.fixed && this.preferences.textColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("textColor", newValue ?? null);
@@ -511,7 +511,7 @@ export class EpubPreferencesEditor implements IPreferencesEditor {
   get visitedColor(): Preference<string> {
     return new Preference<string>({
       initialValue: this.preferences.visitedColor,
-      effectiveValue: this.settings.visitedColor || defaultColors.RS__visitedColor,
+      effectiveValue: this.settings.visitedColor || defaultColors.visitedColor,
       isEffective: this.layout !== Layout.fixed && this.preferences.visitedColor !== null,
       onChange: (newValue: string | null | undefined) => {
         this.updatePreference("visitedColor", newValue ?? null);

package/src/helpers/lineLength.ts

@@ -27,7 +27,7 @@ export interface ILineLengths {
 }
 
 const DEFAULT_FONT_SIZE = 16;
-const DEFAULT_FONT_FACE = fontStacks.RS__oldStyleTf;
+const DEFAULT_FONT_FACE = fontStacks.oldStyleTf;
 
 // Notes: 
 // 

package/src/preferences/Types.ts

@@ -1,8 +1,28 @@
 import RCSSExperiments from "@readium/css/css/vars/experiments.json";
+import RCSSSettings from "@readium/css/css/vars/settings.json";
+import RCSSI18n from "@readium/css/css/vars/i18n.json";
 
 export type ExperimentKey = keyof typeof RCSSExperiments;
+export type SettingsKey = keyof typeof RCSSSettings;
+export type I18nKey = keyof typeof RCSSI18n;
+
+export type RCSSSettingsProperty =
+  | (typeof RCSSSettings)[SettingsKey]["disabled"][number]
+  | (typeof RCSSSettings)[SettingsKey]["added"][number];
+
+export type RCSSSettingsEntry = {
+  disabled: readonly RCSSSettingsProperty[];
+  added: readonly RCSSSettingsProperty[];
+}
+
+export type RCSSI18nEntry = {
+  baseFontFamily: string;
+  lineHeightCompensation?: number;
+}
 
 export const experiments = RCSSExperiments;
+export const settings: Record<SettingsKey, RCSSSettingsEntry> = RCSSSettings;
+export const i18n: Record<I18nKey, RCSSI18nEntry> = RCSSI18n;
 
 export enum TextAlignment {
   start = "start",
@@ -44,7 +64,7 @@ export const letterSpacingRangeConfig: RangeConfig = {
 }
 
 export const lineHeightRangeConfig: RangeConfig = {
-  range: [1, 2],
+  range: [1, 2.5],
   step: .1
 }
 

package/src/webpub/WebPubNavigator.ts

@@ -1,12 +1,11 @@
 import { Feature, Link, Locator, Publication, ReadingProgression, LocatorLocations } from "@readium/shared";
-import { VisualNavigator, VisualNavigatorViewport, ProgressionRange } from "../Navigator.ts";
+import { VisualNavigator, VisualNavigatorViewport, ProgressionRange, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { WebPubFramePoolManager } from "./WebPubFramePoolManager.ts";
 import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, KeyboardPeripheralEvent, ModuleName, SuspiciousActivityEvent, WebPubModules } from "@readium/navigator-html-injectables";
 import * as path from "path-browserify";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
-
-import { KeyboardPeripheralEventData, ManagerEventKey } from "../epub/EpubNavigator.ts";
+import { ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { getScriptMode } from "../helpers/scriptMode.ts";
 import { WebPubCSS } from "./css/WebPubCSS.ts";
 import { WebUserProperties, WebRSProperties } from "./css/Properties.ts";

package/types/src/Navigator.d.ts

@@ -1,6 +1,9 @@
 import { Link, Locator, Publication, ReadingProgression } from "@readium/shared";
-import { ContentProtectionConfig, PrintProtectionConfig, KeyboardPeripheral } from "@readium/navigator-html-injectables";
+import { ContentProtectionConfig, PrintProtectionConfig, KeyboardPeripheral, KeyboardPeripheralEvent } from "@readium/navigator-html-injectables";
 type cbb = (ok: boolean) => void;
+export interface KeyboardPeripheralEventData extends Omit<KeyboardPeripheralEvent, 'interactiveElement'> {
+    interactiveElement?: Element;
+}
 export type IKeyboardPeripheralsConfig = Array<Omit<KeyboardPeripheral, 'type'> & {
     type: Exclude<string, 'developer_tools' | 'select_all' | 'print' | 'save'>;
 }>;

package/types/src/audio/AudioNavigator.d.ts

@@ -1,8 +1,8 @@
 import { Link, Locator, Publication, Timeline, TimelineItem } from "@readium/shared";
-import { MediaNavigator, IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator.ts";
+import { MediaNavigator, IContentProtectionConfig, IKeyboardPeripheralsConfig, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { AudioPreferences, AudioSettings, AudioPreferencesEditor, IAudioPreferences, IAudioDefaults } from "./preferences/index.ts";
-import { ContextMenuEvent, KeyboardEventData, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
+import { ContextMenuEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
 export interface AudioMetadata {
     duration: number;
     textTracks: TextTrackList;
@@ -22,7 +22,7 @@ export interface AudioNavigatorListeners {
     seeking: (isSeeking: boolean) => void;
     seekable: (seekable: TimeRanges) => void;
     contentProtection: (type: string, data: SuspiciousActivityEvent) => void;
-    peripheral: (data: KeyboardEventData) => void;
+    peripheral: (data: KeyboardPeripheralEventData) => void;
     contextMenu: (data: ContextMenuEvent) => void;
     remotePlaybackStateChanged: (state: RemotePlaybackState) => void;
 }

package/types/src/epub/EpubNavigator.d.ts

@@ -2,7 +2,7 @@ import { Layout, Link, Locator, Publication, ReadingProgression } from "@readium
 import { Configurable, ConfigurableSettings, VisualNavigator, VisualNavigatorViewport } from "../index.ts";
 import { FramePoolManager } from "./frame/FramePoolManager.ts";
 import { FXLFramePoolManager } from "./fxl/FXLFramePoolManager.ts";
-import { CommsEventKey, ContextMenuEvent, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent, KeyboardPeripheralEvent } from "@readium/navigator-html-injectables";
+import { CommsEventKey, ContextMenuEvent, BasicTextSelection, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
 import { FXLFrameManager } from "./fxl/FXLFrameManager.ts";
 import { FrameManager } from "./frame/FrameManager.ts";
 import { IEpubPreferences, EpubPreferences } from "./preferences/EpubPreferences.ts";
@@ -10,11 +10,8 @@ import { IEpubDefaults } from "./preferences/EpubDefaults.ts";
 import { EpubSettings } from "./preferences/index.ts";
 import { EpubPreferencesEditor } from "./preferences/EpubPreferencesEditor.ts";
 import { IInjectablesConfig } from "../injection/Injectable.ts";
-import { IContentProtectionConfig, IKeyboardPeripheralsConfig } from "../Navigator.ts";
+import { IContentProtectionConfig, IKeyboardPeripheralsConfig, KeyboardPeripheralEventData } from "../Navigator.ts";
 export type ManagerEventKey = "zoom";
-export interface KeyboardPeripheralEventData extends Omit<KeyboardPeripheralEvent, 'interactiveElement'> {
-    interactiveElement?: Element;
-}
 export interface EpubNavigatorConfiguration {
     preferences: IEpubPreferences;
     defaults: IEpubDefaults;

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

@@ -1,5 +1,18 @@
 import RCSSExperiments from "@readium/css/css/vars/experiments.json";
+import RCSSSettings from "@readium/css/css/vars/settings.json";
+import RCSSI18n from "@readium/css/css/vars/i18n.json";
 export type ExperimentKey = keyof typeof RCSSExperiments;
+export type SettingsKey = keyof typeof RCSSSettings;
+export type I18nKey = keyof typeof RCSSI18n;
+export type RCSSSettingsProperty = (typeof RCSSSettings)[SettingsKey]["disabled"][number] | (typeof RCSSSettings)[SettingsKey]["added"][number];
+export type RCSSSettingsEntry = {
+    disabled: readonly RCSSSettingsProperty[];
+    added: readonly RCSSSettingsProperty[];
+};
+export type RCSSI18nEntry = {
+    baseFontFamily: string;
+    lineHeightCompensation?: number;
+};
 export declare const experiments: {
     experimentalHeaderFiltering: {
         description: string;
@@ -12,6 +25,8 @@ export declare const experiments: {
         value: string;
     };
 };
+export declare const settings: Record<SettingsKey, RCSSSettingsEntry>;
+export declare const i18n: Record<I18nKey, RCSSI18nEntry>;
 export declare enum TextAlignment {
     start = "start",
     left = "left",

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

@@ -1,9 +1,9 @@
 import { Link, Locator, Publication, ReadingProgression } from "@readium/shared";
-import { VisualNavigator, VisualNavigatorViewport } from "../Navigator.ts";
+import { VisualNavigator, VisualNavigatorViewport, KeyboardPeripheralEventData } from "../Navigator.ts";
 import { Configurable } from "../preferences/Configurable.ts";
 import { BasicTextSelection, CommsEventKey, ContextMenuEvent, FrameClickEvent, SuspiciousActivityEvent } from "@readium/navigator-html-injectables";
 import { WebPubFrameManager } from "./WebPubFrameManager.ts";
-import { KeyboardPeripheralEventData, ManagerEventKey } from "../epub/EpubNavigator.ts";
+import { ManagerEventKey } from "../epub/EpubNavigator.ts";
 import { IWebPubPreferences, WebPubPreferences } from "./preferences/WebPubPreferences.ts";
 import { IWebPubDefaults } from "./preferences/WebPubDefaults.ts";
 import { WebPubSettings } from "./preferences/WebPubSettings.ts";