react-native-readium 1.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jacob Spizziri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,135 @@
+# react-native-readium
+
+A react-native wrapper for https://readium.org/
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Supported Formats & DRM](#supported-formats--drm)
+- [API](#api)
+- [Contributing](#contributing)
+- [Release](#release)
+- [License](#license)
+
+## Installation
+
+
+#### Install Module
+**NPM**
+
+```sh
+npm install react-native-readium
+```
+
+**Yarn**
+
+```sh
+yarn add react-native-readium
+```
+
+
+#### Pod Install
+
+Due to the current state of the `Readium` swift libraries you need to manually
+update your `Podfile` ([see more on that here](https://github.com/readium/swift-toolkit/issues/38)).
+
+```rb
+# ./ios/Podfile
+...
+
+target 'ExampleApp' do
+  config = use_native_modules!
+  ...
+  pod 'GCDWebServer', podspec: 'https://raw.githubusercontent.com/readium/GCDWebServer/a8edee9790ef0995b2cf620ba1a9b5cf146b7221/GCDWebServer.podspec', modular_headers: true
+  pod 'R2Shared', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumShared.podspec'
+  pod 'R2Streamer', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumStreamer.podspec'
+  pod 'R2Navigator', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumNavigator.podspec'
+  pod 'ReadiumOPDS', podspec: 'https://raw.githubusercontent.com/readium/swift-toolkit/2.2.0/Support/CocoaPods/ReadiumOPDS.podspec'
+  pod 'Minizip', modular_headers: true
+  ...
+end
+```
+
+Finally, install the pods:
+
+`pod install`
+
+## Usage
+
+```tsx
+import React, { useState } from 'react';
+import { ReadiumView } from 'react-native-readium';
+import type { File } from 'react-native-readium';
+
+const MyComponent: React.FC = () => {
+  const [file] = useState<File>({
+    url: SOME_LOCAL_FILE_URL,
+  });
+
+  return (
+    <ReadiumView
+      file={file}
+    />
+  );
+}
+```
+
+[Take a look at the Example App](https://github.com/5-stones/react-native-readium/blob/main/example/src/App.tsx) for a more complex usage example.
+
+## Supported Formats & DRM
+
+#### Format Support
+
+| Format | Support | Notes |
+|--------|---------|-------|
+| Epub 2 | :white_check_mark: | |
+| Epub 3 | :white_check_mark: | |
+| PDF | :x: | On the roadmap, feel free to submit a PR or ask for direction. |
+| CBZ | :x: | On the roadmap, feel free to submit a PR or ask for direction. |
+
+**Missing a format you need?** Reach out and see if it can be added to the roadmap.
+
+#### DRM Support
+
+DRM is not supported at this time. However, there is a clear path to [support it via LCP](https://www.edrlab.org/readium-lcp/) and the intention is to eventually implement it.
+
+## API
+
+#### View Props
+
+| Name | Type | Optional | Description |
+|------|------|----------|-------------|
+| `file`     | [`File`](https://github.com/5-stones/react-native-readium/blob/main/src/interfaces/File.ts)               | :x:                | A file object containing the path to the eBook file on disk. |
+| `location` | [`Locator`](https://github.com/5-stones/react-native-readium/blob/main/src/interfaces/Locator.ts)            | :white_check_mark: | A locator prop that allows you to externally control the location of the reader (e.g. Chapters or Bookmarks)|
+| `settings` | [`Partial<Settings>`](https://github.com/5-stones/react-native-readium/blob/main/src/interfaces/Settings.ts)  | :white_check_mark: | An object that allows you to control various aspects of the reader's UI (epub only) |
+| `style`    | `ViewStyle`          | :white_check_mark: | A traditional style object. |
+| `onLocationChange` | `(locator: Locator) => void` | :white_check_mark: | A callback that fires whenever the location is changed (e.g. the user transitions to a new page)|
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## Release
+
+The standard release command for this project is:
+
+```
+yarn version
+```
+
+This command will:
+
+1. Generate/update the Changelog
+1. Bump the package version
+1. Tag & pushing the commit
+
+
+e.g.
+
+```
+yarn version --new-version 1.2.17
+yarn version --patch // 1.2.17 -> 1.2.18
+```
+
+## License
+
+MIT

package/android/build.gradle

@@ -0,0 +1,198 @@
+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.1.1'
+
+  repositories {
+    google()
+    mavenCentral()
+    jcenter()
+  }
+
+  dependencies {
+    classpath 'com.android.tools.build:gradle:4.2.2'
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+  }
+}
+
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+def getExtOrDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['Readium_' + name]
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties['Readium_' + name]).toInteger()
+}
+
+android {
+  compileSdkVersion getExtOrIntegerDefault('compileSdkVersion')
+  defaultConfig {
+    minSdkVersion 21
+    targetSdkVersion getExtOrIntegerDefault('targetSdkVersion')
+    versionCode 1
+    versionName "1.0"
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+  lintOptions {
+    disable 'GradleCompatible'
+  }
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  kotlinOptions {
+    jvmTarget = "1.8"
+  }
+
+  buildFeatures {
+    viewBinding true
+  }
+}
+
+repositories {
+
+  maven { url 'https://jitpack.io' }
+
+  mavenCentral()
+  jcenter()
+  google()
+
+  def found = false
+  def defaultDir = null
+  def androidSourcesName = 'React Native sources'
+
+  if (rootProject.ext.has('reactNativeAndroidRoot')) {
+    defaultDir = rootProject.ext.get('reactNativeAndroidRoot')
+  } else {
+    defaultDir = new File(
+            projectDir,
+            '/../../../node_modules/react-native/android'
+    )
+  }
+
+  if (defaultDir.exists()) {
+    maven {
+      url defaultDir.toString()
+      name androidSourcesName
+    }
+
+    logger.info(":${project.name}:reactNativeAndroidRoot ${defaultDir.canonicalPath}")
+    found = true
+  } else {
+    def parentDir = rootProject.projectDir
+
+    1.upto(5, {
+      if (found) return true
+      parentDir = parentDir.parentFile
+
+      def androidSourcesDir = new File(
+              parentDir,
+              'node_modules/react-native'
+      )
+
+      def androidPrebuiltBinaryDir = new File(
+              parentDir,
+              'node_modules/react-native/android'
+      )
+
+      if (androidPrebuiltBinaryDir.exists()) {
+        maven {
+          url androidPrebuiltBinaryDir.toString()
+          name androidSourcesName
+        }
+
+        logger.info(":${project.name}:reactNativeAndroidRoot ${androidPrebuiltBinaryDir.canonicalPath}")
+        found = true
+      } else if (androidSourcesDir.exists()) {
+        maven {
+          url androidSourcesDir.toString()
+          name androidSourcesName
+        }
+
+        logger.info(":${project.name}:reactNativeAndroidRoot ${androidSourcesDir.canonicalPath}")
+        found = true
+      }
+    })
+  }
+
+  if (!found) {
+    throw new GradleException(
+            "${project.name}: unable to locate React Native android sources. " +
+                    "Ensure you have you installed React Native as a dependency in your project and try again."
+    )
+  }
+}
+
+def kotlin_version = getExtOrDefault('kotlinVersion')
+
+dependencies {
+  // noinspection GradleDynamicVersion
+  api 'com.facebook.react:react-native:+'
+  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"
+
+  // 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.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.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.recyclerview:recyclerview:1.2.1"
+  implementation "androidx.viewpager2:viewpager2:1.0.0"
+  implementation "androidx.webkit:webkit:1.4.0"
+  //noinspection GradleDependency
+  implementation ("com.github.edrlab.nanohttpd:nanohttpd:master-SNAPSHOT") {
+      exclude group: 'org.parboiled'
+  }
+  //noinspection GradleDependency
+  implementation ("com.github.edrlab.nanohttpd:nanohttpd-nanolets:master-SNAPSHOT") {
+      exclude group: 'org.parboiled'
+  }
+  implementation "com.google.android.material:material:1.4.0"
+  implementation "com.jakewharton.timber:timber:4.7.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"
+  // AM NOTE: needs to stay this version for now (June 24,2020)
+  //noinspection GradleDependency
+  implementation 'org.jsoup:jsoup:1.13.1'
+
+  // 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"
+
+  implementation 'androidx.lifecycle:lifecycle-extensions:2.2.0'
+  //noinspection LifecycleAnnotationProcessorWithJava8
+  annotationProcessor "androidx.lifecycle:lifecycle-compiler:2.3.1"
+
+  testImplementation "org.jetbrains.kotlin:kotlin-test-junit:$kotlin_version"
+  testImplementation "junit:junit:4.13.2"
+
+  androidTestImplementation "androidx.test.espresso:espresso-core:3.4.0"
+  androidTestImplementation "androidx.test:runner:1.4.0"
+}

package/android/gradle.properties

@@ -0,0 +1,3 @@
+Readium_kotlinVersion=1.5.31
+Readium_compileSdkVersion=31
+Readium_targetSdkVersion=29

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,4 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.reactnativereadium">
+
+</manifest>

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

@@ -0,0 +1,17 @@
+package com.reactnativereadium
+
+import com.facebook.react.ReactPackage
+import com.facebook.react.bridge.NativeModule
+import com.facebook.react.bridge.ReactApplicationContext
+import com.facebook.react.uimanager.ViewManager
+
+
+class ReadiumPackage : ReactPackage {
+    override fun createNativeModules(reactContext: ReactApplicationContext): List<NativeModule> {
+        return emptyList()
+    }
+
+    override fun createViewManagers(reactContext: ReactApplicationContext): List<ViewManager<*, *>> {
+        return listOf(ReadiumViewManager(reactContext))
+    }
+}

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

@@ -0,0 +1,84 @@
+package com.reactnativereadium
+
+import android.view.Choreographer
+import android.widget.FrameLayout
+import androidx.fragment.app.FragmentActivity
+import com.facebook.react.bridge.Arguments
+import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.events.RCTEventEmitter
+import com.reactnativereadium.reader.BaseReaderFragment
+import com.reactnativereadium.reader.EpubReaderFragment
+import com.reactnativereadium.reader.ReaderViewModel
+import com.reactnativereadium.utils.Dimensions
+import org.readium.r2.shared.extensions.toMap
+import org.readium.r2.shared.publication.Locator
+
+class ReadiumView(
+  val reactContext: ThemedReactContext
+) : FrameLayout(reactContext) {
+  var dimensions: Dimensions = Dimensions(0,0)
+  var fragment: BaseReaderFragment? = null
+
+  fun updateLocation(locator: Locator) : Boolean {
+    if (fragment == null) {
+      return false
+    } else {
+      return this.fragment!!.go(locator, true)
+    }
+  }
+
+  fun updateSettingsFromMap(map: Map<String, Any>) {
+    if (fragment != null && fragment is EpubReaderFragment) {
+      (fragment as EpubReaderFragment).updateSettingsFromMap(map)
+    }
+  }
+
+  fun addFragment(frag: BaseReaderFragment) {
+    fragment = frag
+    setupLayout()
+    val activity: FragmentActivity? = reactContext.currentActivity as FragmentActivity?
+    activity!!.supportFragmentManager
+      .beginTransaction()
+      .replace(this.id, frag, this.id.toString())
+      .commit()
+
+    // subscribe to reader events
+    frag.channel.receive(frag) { event ->
+      val module = reactContext.getJSModule(RCTEventEmitter::class.java)
+      when (event) {
+        is ReaderViewModel.Event.LocatorUpdate -> {
+          val json = event.locator.toJSON()
+          val payload = Arguments.makeNativeMap(json.toMap())
+          module.receiveEvent(
+            this.id.toInt(),
+            ReadiumViewManager.ON_LOCATION_CHANGE,
+            payload
+          )
+        }
+      }
+    }
+  }
+
+  private fun setupLayout() {
+    Choreographer.getInstance().postFrameCallback(object : Choreographer.FrameCallback {
+      override fun doFrame(frameTimeNanos: Long) {
+        manuallyLayoutChildren()
+        this@ReadiumView.viewTreeObserver.dispatchOnGlobalLayout()
+        Choreographer.getInstance().postFrameCallback(this)
+      }
+    })
+  }
+
+  /**
+   * Layout all children properly
+   */
+  private fun manuallyLayoutChildren() {
+    // propWidth and propHeight coming from react-native props
+    val width = dimensions.width
+    val height = dimensions.height
+    this.measure(
+      MeasureSpec.makeMeasureSpec(width, MeasureSpec.EXACTLY),
+      MeasureSpec.makeMeasureSpec(height, MeasureSpec.EXACTLY))
+    this.layout(0, 0, width, height)
+  }
+}

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

@@ -0,0 +1,80 @@
+package com.reactnativereadium
+
+import com.facebook.react.bridge.*
+import com.facebook.react.common.MapBuilder
+import com.facebook.react.uimanager.annotations.ReactProp
+import com.facebook.react.uimanager.annotations.ReactPropGroup
+import com.facebook.react.uimanager.ThemedReactContext
+import com.facebook.react.uimanager.ViewGroupManager
+import com.reactnativereadium.reader.ReaderService
+import kotlinx.coroutines.runBlocking
+import org.json.JSONObject
+import org.readium.r2.shared.publication.Locator
+
+
+class ReadiumViewManager(
+  val reactContext: ReactApplicationContext
+) : ViewGroupManager<ReadiumView>() {
+  private var svc = ReaderService(reactContext)
+
+  override fun getName() = "ReadiumView"
+
+  override fun createViewInstance(reactContext: ThemedReactContext): ReadiumView {
+    return ReadiumView(reactContext)
+  }
+
+  override fun getExportedCustomBubblingEventTypeConstants(): Map<String, Any> {
+    return MapBuilder.builder<String, Any>().put(
+      ON_LOCATION_CHANGE,
+      MapBuilder.of(
+        "phasedRegistrationNames",
+        MapBuilder.of("bubbled", ON_LOCATION_CHANGE)
+      )
+    ).build()
+  }
+
+  @ReactProp(name = "file")
+  fun setFile(view: ReadiumView, file: ReadableMap) {
+    val path = file.getString("url")
+    val locatorMap = file.getMap("initialLocation")
+    var initialLocation: Locator? = null
+
+    if (locatorMap != null) {
+      initialLocation = Locator.fromJSON(JSONObject(locatorMap.toHashMap()))
+    }
+
+    runBlocking {
+      svc.openPublication(path!!, initialLocation) { fragment ->
+        view.addFragment(fragment)
+      }
+    }
+  }
+
+  @ReactProp(name = "location")
+  fun setLocation(view: ReadiumView, location: ReadableMap) {
+    val locator = Locator.fromJSON(JSONObject(location.toHashMap()))
+
+    if (locator != null) {
+      view.updateLocation(locator)
+    }
+  }
+
+  @ReactProp(name = "settings")
+  fun setSettings(view: ReadiumView, settings: ReadableMap) {
+    view.updateSettingsFromMap(settings.toHashMap())
+  }
+
+  @ReactPropGroup(names = ["width", "height"], customType = "Style")
+  fun setStyle(view: ReadiumView?, index: Int, value: Int) {
+    if (index == 0) {
+      view?.dimensions?.width = value
+    }
+    if (index == 1) {
+      view?.dimensions?.height = value
+    }
+  }
+
+  companion object {
+    var ON_LOCATION_CHANGE = "onLocationChange"
+  }
+}