react-native-readium 1.2.0 → 2.0.0-rc.0

package/README.md

@@ -1,5 +1,26 @@
 # react-native-readium
 
+[![NPM version](https://img.shields.io/npm/v/react-native-readium.svg?color=success&label=npm%20package&logo=npm)](https://www.npmjs.com/package/react-native-readium)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+![PRs welcome!](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
+![This project is released under the MIT license](https://img.shields.io/badge/license-MIT-blue.svg)
+
+----
+
+## Have A Bug/Feature You Care About?
+
+We :heart: open source. We work on the things that are important to us when
+we're able to work on them. Have an issue you care about?
+
+- [Dive Into The Code!](CONTRIBUTING.md)
+- [Sponsor Your Issue](https://issuehunt.io/r/5-stones/react-native-readium).
+
+[![Issue Hunt](https://issuehunt.io/static/embed/issuehunt-button-v1.svg)](https://issuehunt.io/r/5-stones/react-native-readium)
+
+----
+
+## Overview
+
 A react-native wrapper for https://readium.org/. At a high level this package
 allows you to do things like:
 
@@ -13,7 +34,7 @@ allows you to do things like:
   - More (see the `Settings` documentation in the [API section](#api))
 - Etc. (read on for more details. :book:)
 
-## Overview
+## Table of Contents
 
 - [Installation](#installation)
 - [Usage](#usage)
@@ -24,7 +45,7 @@ allows you to do things like:
 - [License](#license)
 
 | Dark Mode| Light Mode |
-|---|---|
+|----------|------------|
 | ![Dark Mode](https://github.com/5-stones/react-native-readium/blob/main/docs/demo-dark-mode.gif) | ![Light Mode](https://github.com/5-stones/react-native-readium/blob/main/docs/demo-light-mode.gif) |
 
 ## Installation
@@ -63,10 +84,11 @@ platform :ios, '13.0'
 target 'ExampleApp' do
   config = use_native_modules!
   ...
-  pod 'GCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/3ec154d358f26858071feaa6429e0f1c16bb11bd/GCDWebServer.podspec', modular_headers: true
-  pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.4.0/Support/CocoaPods/ReadiumShared.podspec'
-  pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.4.0/Support/CocoaPods/ReadiumStreamer.podspec'
-  pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.4.0/Support/CocoaPods/ReadiumNavigator.podspec'
+  pod 'GCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/3.7.5/GCDWebServer.podspec', modular_headers: true
+  pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.0/Support/CocoaPods/ReadiumNavigator.podspec'
+  pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.0/Support/CocoaPods/ReadiumShared.podspec'
+  pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.0/Support/CocoaPods/ReadiumStreamer.podspec'
+  pod 'ReadiumInternal', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.6.0/Support/CocoaPods/ReadiumInternal.podspec'
   pod 'Minizip', modular_headers: true
   ...
 end
@@ -78,23 +100,6 @@ Finally, install the pods:
 
 #### Android
 
-You might need to [add `jcenter` if you're getting a build failure on android](https://github.com/readium/kotlin-toolkit/issues/31):
-
-```groovy
-// android/build.gradle
-...
-
-allprojects {
-    repositories {
-        ...
-        // required by react-native-readium https://github.com/readium/kotlin-toolkit/issues/31
-        jcenter()
-    }
-    ...
-}
-...
-```
-
 If you're not using `compileSdkVersion` >= 31 you'll need to update that:
 
 ```groovy

package/android/build.gradle

@@ -1,12 +1,11 @@
 buildscript {
   // Buildscript is evaluated before everything else so we can't use getExtOrDefault
   def kotlin_version = rootProject.ext.has('kotlinVersion') ? rootProject.ext.get('kotlinVersion') : project.properties['Readium_kotlinVersion']
-  ext.readium_version = '2.2.1'
+  ext.readium_version = '2.4.1'
 
   repositories {
     google()
     mavenCentral()
-    jcenter()
   }
 
   dependencies {
@@ -49,21 +48,13 @@ android {
     targetCompatibility JavaVersion.VERSION_1_8
   }
 
-  kotlinOptions {
-    jvmTarget = "1.8"
-  }
-
   buildFeatures {
     viewBinding true
   }
 }
 
 repositories {
-
-  maven { url 'https://jitpack.io' }
-
   mavenCentral()
-  jcenter()
   google()
 
   def found = false
@@ -140,51 +131,51 @@ dependencies {
   implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
   // readium deps
-  implementation "com.github.readium.kotlin-toolkit:readium-shared:$readium_version"
-  implementation "com.github.readium.kotlin-toolkit:readium-streamer:$readium_version"
-  implementation ("com.github.readium.kotlin-toolkit:readium-navigator:$readium_version") {
+  implementation "org.readium.kotlin-toolkit:readium-shared:$readium_version"
+  implementation "org.readium.kotlin-toolkit:readium-streamer:$readium_version"
+  implementation ("org.readium.kotlin-toolkit:readium-navigator:$readium_version") {
     // this package doesn't provide audio playback, so remove exoplayer
     // transitive deps to avoid potential collisions with other projects.
     exclude group: "com.google.android.exoplayer"
   }
 
   // other deps
-  implementation "androidx.core:core-ktx:1.6.0"
-  implementation "androidx.activity:activity-ktx:1.3.1"
-  implementation "androidx.appcompat:appcompat:1.3.1"
-  implementation "androidx.browser:browser:1.3.0"
+  implementation "androidx.core:core-ktx:1.7.0"
+  implementation "androidx.activity:activity-ktx:1.4.0"
+  implementation "androidx.appcompat:appcompat:1.4.1"
+  implementation "androidx.browser:browser:1.4.0"
   implementation "androidx.cardview:cardview:1.0.0"
-  implementation "androidx.constraintlayout:constraintlayout:2.1.1"
-  implementation "androidx.fragment:fragment-ktx:1.3.6"
-  implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.3.1"
-  implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.3.1"
-  implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.3.1"
+  implementation "androidx.constraintlayout:constraintlayout:2.1.3"
+  implementation "androidx.fragment:fragment-ktx:1.4.0"
+  implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.4.0"
+  implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.4.0"
+  implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.4.0"
   implementation 'androidx.navigation:navigation-fragment-ktx:2.3.5'
   implementation 'androidx.navigation:navigation-ui-ktx:2.3.5'
-  implementation "androidx.paging:paging-runtime-ktx:3.0.1"
+  implementation "androidx.paging:paging-runtime-ktx:3.1.0"
   implementation "androidx.recyclerview:recyclerview:1.2.1"
   implementation "androidx.viewpager2:viewpager2:1.0.0"
   implementation "androidx.webkit:webkit:1.4.0"
-  implementation "com.google.android.material:material:1.4.0"
-  implementation "com.jakewharton.timber:timber:4.7.1"
+  implementation "com.google.android.material:material:1.5.0"
+  implementation "com.jakewharton.timber:timber:5.0.1"
   // AM NOTE: needs to stay this version for now (June 24,2020)
   //noinspection GradleDependency
-  implementation "com.squareup.picasso:picasso:2.5.2"
-  implementation "joda-time:joda-time:2.10.10"
-  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.2"
+  implementation "com.squareup.picasso:picasso:2.71828"
+  implementation "joda-time:joda-time:2.10.13"
+  implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.0"
   // AM NOTE: needs to stay this version for now (June 24,2020)
   //noinspection GradleDependency
-  implementation "org.jsoup:jsoup:1.13.1"
+  implementation "org.jsoup:jsoup:1.14.3"
 
   // Room database
-  final room_version = "2.4.0-beta01"
-  implementation "androidx.room:room-runtime:$room_version"
-  implementation "androidx.room:room-ktx:$room_version"
-  annotationProcessor "androidx.room:room-compiler:$room_version"
+  final roomVersion = "2.4.1"
+  implementation "androidx.room:room-runtime:$roomVersion"
+  implementation "androidx.room:room-ktx:$roomVersion"
+  annotationProcessor "androidx.room:room-compiler:$roomVersion"
 
   implementation "androidx.lifecycle:lifecycle-extensions:2.2.0"
   //noinspection LifecycleAnnotationProcessorWithJava8
-  annotationProcessor "androidx.lifecycle:lifecycle-compiler:2.3.1"
+  annotationProcessor "androidx.lifecycle:lifecycle-compiler:2.4.0"
 
   testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
   testImplementation "junit:junit:4.13.2"

package/android/src/main/java/com/reactnativereadium/ReadiumView.kt

@@ -78,6 +78,9 @@ class ReadiumView(
             payload
           )
         }
+        else -> {
+          // do nothing
+        }
       }
     }
   }

package/android/src/main/res/layout/fragment_fxllayout_double.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?><!--
+  FIXME: this was imported from `kotlin-toolkit/readium/navigator/src/main/res/layout@v2.2.1`.
+    Not sure why it's not being imported from readium-navigator, but if its not here
+    the android build throws an error due to UserSettings.kt#updateViewCSS
+
+  ~ Module: r2-navigator-kotlin
+  ~ Developers: Aferdita Muriqi
+  ~
+  ~ Copyright (c) 2018. Readium Foundation. All rights reserved.
+  ~ Use of this source code is governed by a BSD-style license which is detailed in the
+  ~ LICENSE file present in the project repository where this source code is maintained.
+  -->
+
+<org.readium.r2.navigator.epub.fxl.R2FXLLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/r2FXLLayout"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent">
+
+    <ScrollView
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:fillViewport="true"
+        android:scrollbars="none">
+
+        <RelativeLayout
+            android:layout_width="match_parent"
+            android:layout_height="match_parent"
+            android:layout_gravity="center">
+
+            <LinearLayout
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:layout_centerInParent="true"
+                android:gravity="center_horizontal"
+                android:orientation="horizontal"
+                tools:ignore="UselessParent">
+
+                <org.readium.r2.navigator.R2BasicWebView
+                    android:id="@+id/firstWebView"
+                    android:layout_width="0dp"
+                    android:layout_height="wrap_content"
+                    android:layout_gravity="end"
+                    android:layout_weight="1"
+                    android:layerType="hardware" />
+
+                <org.readium.r2.navigator.R2BasicWebView
+                    android:id="@+id/secondWebView"
+                    android:layout_width="0dp"
+                    android:layout_height="wrap_content"
+                    android:layout_gravity="start"
+                    android:layout_weight="1"
+                    android:layerType="hardware" />
+
+            </LinearLayout>
+        </RelativeLayout>
+    </ScrollView>
+</org.readium.r2.navigator.epub.fxl.R2FXLLayout>

package/android/src/main/res/layout/fragment_fxllayout_single.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="utf-8"?><!--
+  FIXME: this was imported from `kotlin-toolkit/readium/navigator/src/main/res/layout@v2.2.1`.
+    Not sure why it's not being imported from readium-navigator, but if its not here
+    the android build throws an error due to UserSettings.kt#updateViewCSS
+
+
+  ~ Module: r2-navigator-kotlin
+  ~ Developers: Aferdita Muriqi
+  ~
+  ~ Copyright (c) 2018. Readium Foundation. All rights reserved.
+  ~ Use of this source code is governed by a BSD-style license which is detailed in the
+  ~ LICENSE file present in the project repository where this source code is maintained.
+  -->
+
+<org.readium.r2.navigator.epub.fxl.R2FXLLayout xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/r2FXLLayout"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent">
+
+    <ScrollView
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:fillViewport="true"
+        android:scrollbars="none">
+
+        <RelativeLayout
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:layout_gravity="center">
+
+            <LinearLayout
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:layout_centerInParent="true"
+                android:gravity="center_horizontal"
+                android:orientation="horizontal"
+                tools:ignore="UselessParent">
+
+                <org.readium.r2.navigator.R2BasicWebView
+                    android:id="@+id/webViewSingle"
+                    android:layout_width="0dp"
+                    android:layout_height="wrap_content"
+                    android:layout_weight="1"
+                    android:layerType="hardware" />
+
+            </LinearLayout>
+
+        </RelativeLayout>
+    </ScrollView>
+
+</org.readium.r2.navigator.epub.fxl.R2FXLLayout>

package/android/src/main/res/layout/viewpager_fragment_epub.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  FIXME: this was imported from `kotlin-toolkit/readium/navigator/src/main/res/layout@v2.2.1`.
+    Not sure why it's not being imported from readium-navigator, but if its not here
+    the android build throws an error due to UserSettings.kt#updateViewCSS
+
+  ~ Module: r2-navigator-kotlin
+  ~ Developers: Aferdita Muriqi, Clément Baumann
+  ~
+  ~ Copyright (c) 2018. Readium Foundation. All rights reserved.
+  ~ Use of this source code is governed by a BSD-style license which is detailed in the
+  ~ LICENSE file present in the project repository where this source code is maintained.
+  -->
+
+<androidx.coordinatorlayout.widget.CoordinatorLayout
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:orientation="vertical">
+
+    <org.readium.r2.navigator.R2WebView
+        android:id="@+id/webView"
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"/>
+
+</androidx.coordinatorlayout.widget.CoordinatorLayout>

package/android/src/main/res/values/strings.xml

@@ -1,3 +1,4 @@
 <resources>
     <string name="no_result">No result</string>
+    <string name="epub_navigator_tag">epub_navigator</string>
 </resources>

package/lib/src/components/BaseReadiumView.d.ts

@@ -0,0 +1,2 @@
+import type { BaseReadiumViewProps } from '../interfaces';
+export declare const BaseReadiumView: import("react-native").HostComponent<BaseReadiumViewProps> | (() => never);

package/lib/src/components/BaseReadiumView.js

@@ -0,0 +1,7 @@
+import { requireNativeComponent, UIManager, } from 'react-native';
+import { COMPONENT_NAME, LINKING_ERROR } from '../utils';
+export const BaseReadiumView = UIManager.getViewManagerConfig(COMPONENT_NAME) != null
+    ? requireNativeComponent(COMPONENT_NAME)
+    : () => {
+        throw new Error(LINKING_ERROR);
+    };

package/lib/src/components/BaseReadiumView.web.d.ts

@@ -0,0 +1 @@
+export declare const BaseReadiumView: () => null;

package/lib/src/components/BaseReadiumView.web.js

@@ -0,0 +1 @@
+export const BaseReadiumView = () => null;

package/lib/src/components/ReadiumView.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import type { BaseReadiumViewProps } from '../interfaces';
+export type ReadiumProps = BaseReadiumViewProps;
+export declare const ReadiumView: React.FC<ReadiumProps>;

package/lib/src/components/ReadiumView.js

@@ -0,0 +1,43 @@
+import React, { useCallback, useState, useRef, useEffect } from 'react';
+import { View, Platform, findNodeHandle, StyleSheet } from 'react-native';
+import { Settings } from '../interfaces';
+import { createFragment, getWidthOrHeightValue as dimension } from '../utils';
+import { BaseReadiumView } from './BaseReadiumView';
+export const ReadiumView = ({ onLocationChange: wrappedOnLocationChange, onTableOfContents: wrappedOnTableOfContents, settings: unmappedSettings, ...props }) => {
+    const ref = useRef(null);
+    const [{ height, width }, setDimensions] = useState({
+        width: 0,
+        height: 0,
+    });
+    // set the view dimensions on layout
+    const onLayout = useCallback(({ nativeEvent: { layout: { width, height } } }) => {
+        setDimensions({
+            width: dimension(width),
+            height: dimension(height),
+        });
+    }, []);
+    // wrap the native onLocationChange and extract the raw event value
+    const onLocationChange = useCallback((event) => {
+        if (wrappedOnLocationChange) {
+            wrappedOnLocationChange(event.nativeEvent);
+        }
+    }, [wrappedOnLocationChange]);
+    const onTableOfContents = useCallback((event) => {
+        if (wrappedOnTableOfContents) {
+            const toc = event.nativeEvent.toc || null;
+            wrappedOnTableOfContents(toc);
+        }
+    }, [wrappedOnTableOfContents]);
+    useEffect(() => {
+        if (Platform.OS === 'android') {
+            const viewId = findNodeHandle(ref.current);
+            createFragment(viewId);
+        }
+    }, []);
+    return (<View style={styles.container} onLayout={onLayout}>
+      <BaseReadiumView height={height} width={width} {...props} onLocationChange={onLocationChange} onTableOfContents={onTableOfContents} settings={unmappedSettings ? Settings.map(unmappedSettings) : undefined} ref={ref}/>
+    </View>);
+};
+const styles = StyleSheet.create({
+    container: { width: '100%', height: '100%' },
+});

package/lib/src/components/ReadiumView.web.d.ts

@@ -0,0 +1,5 @@
+import React from 'react';
+export declare const ReadiumView: React.ForwardRefExoticComponent<Omit<import("..").BaseReadiumViewProps, "ref"> & React.RefAttributes<{
+    nextPage: () => void;
+    prevPage: () => void;
+}>>;

package/lib/src/components/ReadiumView.web.js

@@ -0,0 +1,61 @@
+import React, { useImperativeHandle } from 'react';
+import { View, StyleSheet } from 'react-native';
+import { useReaderRef, useSettingsObserver, useLocationObserver, } from '../../web/hooks';
+export const ReadiumView = React.forwardRef(({ file, settings, location, onLocationChange, onTableOfContents, style = {}, height, width, }, ref) => {
+    const readerRef = useReaderRef({
+        file,
+        onLocationChange,
+        onTableOfContents,
+    });
+    const reader = readerRef.current;
+    useImperativeHandle(ref, () => ({
+        nextPage: () => {
+            readerRef.current?.nextPage();
+        },
+        prevPage: () => {
+            readerRef.current?.previousPage();
+        },
+    }));
+    useSettingsObserver(reader, settings);
+    useLocationObserver(reader, location);
+    const mainStyle = {
+        ...styles.maximize,
+        ...style,
+    };
+    if (height)
+        mainStyle.height = height;
+    if (width)
+        mainStyle.width = width;
+    return (<View style={styles.container}>
+      {!reader && <div style={loaderStyle}>Loading reader...</div>}
+      <div id="D2Reader-Container" style={styles.d2Container}>
+        <main style={mainStyle} tabIndex={-1} id="iframe-wrapper">
+          <div id="reader-loading" className="loading" style={loaderStyle}></div>
+          <div id="reader-error" className="error"></div>
+        </main>
+      </div>
+    </View>);
+});
+const loaderStyle = {
+    width: '100%',
+    height: '100%',
+    textAlign: 'center',
+    position: 'relative',
+    top: 'calc(50% - 10px)',
+};
+const styles = StyleSheet.create({
+    container: {
+        width: '100%',
+        height: '100%',
+    },
+    d2Container: {
+        width: '100%',
+        height: '100%',
+        display: 'flex',
+    },
+    maximize: {
+        width: '100%',
+        height: '100%',
+        display: 'flex',
+    },
+});

package/lib/src/enums/Appearance.js

@@ -0,0 +1,13 @@
+// NOTE: readium uses an index so the order is very important here
+export var Appearance;
+(function (Appearance) {
+    /**
+     * A traditional "light" mode
+     */
+    Appearance["DEFAULT"] = "readium-default-on";
+    Appearance["SEPIA"] = "readium-sepia-on";
+    /**
+     * A traditional "dark" mode
+     */
+    Appearance["NIGHT"] = "readium-night-on";
+})(Appearance || (Appearance = {}));

package/lib/src/enums/ColumnCount.js

@@ -0,0 +1,7 @@
+// NOTE: readium uses an index so the order is very important here
+export var ColumnCount;
+(function (ColumnCount) {
+    ColumnCount["AUTO"] = "auto";
+    ColumnCount["ONE"] = "1";
+    ColumnCount["TWO"] = "2";
+})(ColumnCount || (ColumnCount = {}));

package/lib/src/enums/FontFamily.js

@@ -0,0 +1,12 @@
+// NOTE: readium uses an index so the order is very important here
+export var FontFamily;
+(function (FontFamily) {
+    FontFamily["ORIGINAL"] = "Original";
+    FontFamily["HELVETICA_NEUE"] = "Helvetica Neue";
+    FontFamily["IOWAN_OLD_STYLE"] = "Iowan Old Style";
+    FontFamily["ATHELAS"] = "Athelas";
+    FontFamily["SERAVEK"] = "Seravek";
+    FontFamily["OPEN_DYSLEXIC"] = "OpenDyslexic";
+    FontFamily["ACCESSIBLE_DFA"] = "AccessibleDfA";
+    FontFamily["IA_WRITER_DUOSPACE"] = "IA Writer Duospace";
+})(FontFamily || (FontFamily = {}));

package/lib/src/enums/TextAlignment.js

@@ -0,0 +1,6 @@
+// NOTE: readium uses an index so the order is very important here
+export var TextAlignment;
+(function (TextAlignment) {
+    TextAlignment["JUSTIFY"] = "justify";
+    TextAlignment["START"] = "start";
+})(TextAlignment || (TextAlignment = {}));

package/lib/{module → src}/enums/index.js

@@ -2,4 +2,3 @@ export * from './Appearance';
 export * from './ColumnCount';
 export * from './FontFamily';
 export * from './TextAlignment';
-//# sourceMappingURL=index.js.map

package/lib/{module → src}/index.js

@@ -2,4 +2,3 @@ export * from './enums';
 export * from './interfaces';
 export { RANGES } from './utils';
 export * from './components/ReadiumView';
-//# sourceMappingURL=index.js.map

package/lib/src/interfaces/BaseReadiumViewProps.d.ts

@@ -0,0 +1,16 @@
+import type { ViewStyle } from 'react-native';
+import type { Settings } from './Settings';
+import type { Link } from './Link';
+import type { Locator } from './Locator';
+import type { File } from './File';
+export type BaseReadiumViewProps = {
+    file: File;
+    location?: Locator | Link;
+    settings?: Partial<Settings>;
+    style?: ViewStyle;
+    onLocationChange?: (locator: Locator) => void;
+    onTableOfContents?: (toc: Link[] | null) => void;
+    ref?: any;
+    height?: number;
+    width?: number;
+};

package/lib/src/interfaces/BaseReadiumViewProps.js

@@ -0,0 +1 @@
+export {};

package/lib/src/interfaces/Dimensions.js

@@ -0,0 +1 @@
+export {};

package/lib/src/interfaces/File.js

@@ -0,0 +1 @@
+export {};

package/lib/src/interfaces/Link.js

@@ -0,0 +1 @@
+export {};

package/lib/src/interfaces/Locator.js

@@ -0,0 +1 @@
+export {};

package/lib/src/interfaces/Settings.js

@@ -0,0 +1,61 @@
+import { Appearance, FontFamily, TextAlignment, ColumnCount, } from '../enums';
+import { RANGES, indexOfObjectValue, clamp, } from '../utils';
+/**
+ * A reader settings object with sensible defaults.
+ */
+export class Settings {
+    // TODO:
+    // - ligatures
+    // - paraIndent
+    appearance = Appearance.DEFAULT;
+    fontFamily = FontFamily.ORIGINAL;
+    textAlign = TextAlignment.JUSTIFY;
+    colCount = ColumnCount.AUTO;
+    scroll = false;
+    fontOverride = false;
+    verticalScroll = false;
+    bodyHyphens = false;
+    advancedSettings = true;
+    /**
+     * Range: 100.0 - 300.0
+     */
+    fontSize = 100;
+    /**
+     * Range: 0.0 - 0.5
+     */
+    wordSpacing = 0;
+    /**
+     * Range: 0.0 - 0.5
+     */
+    letterSpacing = 0;
+    /**
+     * Range: 0.5 - 4.0
+     */
+    pageMargins = 0;
+    /**
+     * Range: 1.0 - 2.0
+     */
+    lineHeight = 1;
+    /**
+     * Range: 0.0 - 2.0
+     */
+    paragraphMargins = 0;
+    static map(settings) {
+        const defaultValues = new Settings();
+        const mapped = {};
+        Object.keys(defaultValues)
+            .forEach((key) => {
+            // @ts-ignore
+            mapped[key] = settings[key] !== undefined ? settings[key] : defaultValues[key];
+        });
+        mapped.appearance = indexOfObjectValue(Appearance, mapped.appearance);
+        mapped.fontFamily = indexOfObjectValue(FontFamily, mapped.fontFamily);
+        mapped.textAlign = indexOfObjectValue(TextAlignment, mapped.textAlign);
+        mapped.colCount = indexOfObjectValue(ColumnCount, mapped.colCount);
+        Object.keys(RANGES).forEach((key) => {
+            // @ts-ignore
+            mapped[key] = clamp(mapped[key], RANGES[key][0], RANGES[key][1]);
+        });
+        return mapped;
+    }
+}

package/lib/{typescript → src}/interfaces/index.d.ts

@@ -1,3 +1,4 @@
+export * from './BaseReadiumViewProps';
 export * from './Dimensions';
 export * from './File';
 export * from './Link';