react-native-readium 1.0.0-alpha.1

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

@@ -0,0 +1,200 @@
+<!--
+  ~ Module: r2-testapp-kotlin
+  ~ Developers: Aferdita Muriqi, Clément Baumann
+  ~
+  ~ Copyright (c) 2018. European Digital Reading Lab. All rights reserved.
+  ~ Licensed to the Readium Foundation under one or more contributor license agreements.
+  ~ 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.
+  -->
+
+<resources>
+    <string name="app_name" translatable="false">R2 Reader</string>
+    <string name="menu_item_show_epub_list">Show List</string>
+    <string name="menu_item_add_epub">Add ePub</string>
+    <string name="menu_item_filter">Filter</string>
+    <string name="progress_wait_while_searching_book">Please wait.</string>
+    <string name="progress_wait">Please wait.</string>
+    <string name="progress_wait_while_downloading_book">Please wait while your publication is being downloaded.</string>
+    <string name="progress_wait_while_preparing_book">Please wait while your publication is being prepared.</string>
+    <string name="progress_wait_while_preparing_audiobook">Please wait while your audiobook is being prepared.</string>
+    <string name="progress_wait_while_loading_feed">Please wait while your feed is loading.</string>
+    <string name="error_invalid_epub">Invalid Epub</string>
+    <string name="fallback_no_description">No description</string>
+    <string name="button_dismiss">DISMISS</string>
+
+    <string name="epubactivity_drm_info">DRM Info</string>
+    <string name="epubactivity_set_bookmark">Add a bookmark</string>
+    <string name="epubactivity_settings">User Settings</string>
+    <string name="epubactivity_book_nav_options">Book navigation menu</string>
+    <string name="epubactivity_read_aloud_start">Read Aloud</string>
+    <string name="epubactivity_read_aloud_stop">Stop Read Aloud</string>
+    <string name="epubactivity_search">Search</string>
+
+    <string name="epubactivity_accessibility">Accessibility</string>
+    <string name="epubactivity_accessibility_screen_reader_start">Start Screen Reader</string>
+    <string name="epubactivity_accessibility_screen_reader_pause">Pause Screen Reader</string>
+    <string name="epubactivity_accessibility_screen_reader_resume">Resume Screen Reader</string>
+    <string name="epubactivity_accessibility_screen_reader_stop">Stop Screen Reader</string>
+
+    <string name="title_activity_opdscatalog">OPDS Catalog</string>
+    <string name="action_settings">Settings</string>
+    <string name="title_activity_r2_about">About R2 Reader</string>
+    <string name="title_activity_opds_list">OPDS Feeds</string>
+    <string name="title_activity_opds_detail">Detail</string>
+    <string name="title_fragment_drm_management">DRM Management</string>
+    <string name="title_activity_epub">Detail</string>
+    <string name="floating_button_add_book">Add a Book</string>
+    <string name="floating_button_add_feed">Add a OPDS Feed</string>
+    <string name="about_r2_reader">About R2 Reader</string>
+    <string name="more_options">More Options</string>
+    <string name="opds_feeds">OPDS Feeds</string>
+    <string name="popup_delete_button">DELETE</string>
+    <string name="add_publication_to_library">Add a publication to your library</string>
+    <string name="select_from_your_device">select from your device</string>
+    <string name="download_from_url">download from a url</string>
+
+    <string name="app_version_header">Version</string>
+    <string name="app_version_label">App Version:</string>
+    <string name="app_version">2.2.0</string>
+    <string name="github_tab_label">GitHub Tag:</string>
+    <string name="github_tag">2.2.0</string>
+
+    <string name="copyright_label">Copyright</string>
+    <string name="copyright">\@ 2019 European Digital Reading Lab</string>
+    <string name="bsd_license_label">[BSD-3 license]</string>
+    <string name="bsd_license_label_accessible">[B S D 3 license]</string>
+    <string name="acknowledgements_label">Acknowledgements</string>
+    <string name="acknowledgements_french_state">R2 Reader wouldn\'t have been developed without the financial help of the French state.</string>
+    <string name="catalog_list_more">More</string>
+    <string name="catalog_detail_download_button">Download</string>
+
+
+    <string name="menu_label_drm">DRM</string>
+    <string name="menu_label_settings">Settings</string>
+    <string name="menu_label_toc">TOC</string>
+    <string name="usersettings_label_font">Font</string>
+    <string name="usersettings_appearance_default">Default</string>
+    <string name="usersettings_appearance_sepia">Sepia</string>
+    <string name="usersettings_appearance_night">Night</string>
+    <string name="usersettings_label_scroll_mode">Scroll mode</string>
+    <string name="usersettings_publisher_default">"Publisher's Default"</string>
+    <string name="usersettings_publisher_default_accessibility">"Publisher's Default Settings"</string>
+    <string name="usersettings_label_columns">Columns</string>
+    <string name="usersettings_auto">Auto</string>
+    <string name="usersettings_column_one">1</string>
+    <string name="usersettings_column_two">2</string>
+    <string name="usersettings_label_page_margins">Page Margins</string>
+    <string name="usersettings_page_margin_default">0.75</string>
+    <string name="usersettings_label_word_spacing">Word Spacing</string>
+    <string name="usersettings_label_letter_spacing">Letter Spacing</string>
+    <string name="usersettings_label_line_height">Line Height</string>
+    <string name="usersettings_label_TTS_speech_speed">TTS speed</string>
+
+    <!-- Accessibility -->
+
+    <string name="usersettings_description_TTS_speech_speed">Set TTS speech speed</string>
+    <string name="usersettings_description_brightness">Set Brightness</string>
+    <string name="usersettings_description_font_increase">Increase Font Size</string>
+    <string name="usersettings_description_font_decrease">Decrease Font Size</string>
+    <string name="usersettings_description_pm_increase">Increase Page Margins Size</string>
+    <string name="usersettings_description_pm_decrease">Decrease Page Margins Size</string>
+    <string name="usersettings_description_ws_increase">Increase Word Spacing</string>
+    <string name="usersettings_description_ws_decrease">Decrease Word Spacing</string>
+    <string name="usersettings_description_ls_increase">Increase Letter Spacing</string>
+    <string name="usersettings_description_ls_decrease">Decrease Letter Spacing</string>
+    <string name="usersettings_description_lh_increase">Increase Line Height</string>
+    <string name="usersettings_description_lh_decrease">Decrease Line Height</string>
+
+    <string name="drm_information_header">INFORMATION</string>
+    <string name="drm_label_license_type">License Type</string>
+    <string name="drm_label_state">State</string>
+    <string name="drm_label_provider">Provider</string>
+    <string name="drm_label_issued">Issued</string>
+    <string name="drm_label_updated">Updated</string>
+    <string name="drm_label_rights">RIGHTS</string>
+    <string name="drm_label_prints_left">Prints left</string>
+    <string name="drm_label_copies_left">Copies left</string>
+    <string name="drm_label_start">Start</string>
+    <string name="drm_label_end">End</string>
+    <string name="drm_label_potential_right_end">Potential right end</string>
+    <string name="drm_label_actions">ACTIONS</string>
+    <string name="drm_label_renew">RENEW</string>
+    <string name="drm_label_return">RETURN</string>
+    <string name="zero">00:00</string>
+    <string name="chapter">Chapter</string>
+    <string name="chapter_page">Chapter / Page</string>
+    <string name="progression">Progression</string>
+    <string name="timestamp">Timestamp</string>
+
+    <!-- Outlines -->
+    <string name="contents_tab_label">Contents</string>
+    <string name="bookmarks_tab_label">Bookmarks</string>
+    <string name="highlights_tab_label">Highlights</string>
+    <string name="pagelist_tab_label">Page List</string>
+    <string name="landmarks_tab_label">Landmarks</string>
+    <string name="action_mode_menu_highlight">Highlight</string>
+    <string name="action_mode_menu_underline">Underline</string>
+    <string name="action_mode_menu_note">Note</string>
+    <string name="bookmark_added">Bookmark added</string>
+    <string name="bookmark_exists">Bookmark already exists</string>
+
+    <string name="title_catalogs">Catalogs</string>
+    <string name="title_bookshelf">Bookshelf</string>
+    <string name="title_about">About</string>
+    <string name="cover_image">Cover Image</string>
+    <string name="repfr">repfr</string>
+
+    <string name="delete">Delete</string>
+    <string name="cancel">Cancel</string>
+    <string name="confirm_delete_book_title">Delete Book?</string>
+    <string name="confirm_delete_book_text">Are you sure you want to delete this book?</string>
+    <string name="confirm_delete_catalog_title">Delete Catalog?</string>
+    <string name="confirm_delete_catalog_text">Are you sure you want to delete this Catalog feed?</string>
+
+    <string name="add_book">Add a Book</string>
+    <string name="add_catalog">Add an Catalog Feed</string>
+    <string name="ok">OK</string>
+    <string name="save">Save</string>
+    <string name="enter_title">Enter the Title</string>
+    <string name="enter_url">Enter the URL</string>
+    <string name="invalid_title">Please enter a title</string>
+    <string name="invalid_url">Please enter a valid URL</string>
+    <string name="catalog_parse_error">Error parsing Catalog feed. Please check the URL and try again</string>
+
+    <string name="publication_image_description">Cover image for %1$s</string>
+
+    <string name="return_publication">This will return the publication</string>
+    <string name="return_button">Return</string>
+
+    <string name="end_of_chapter">End of chapter</string>
+
+    <string name="unable_to_move_pub">Unable to move publication into the library</string>
+    <string name="import_publication_success">Publication added to your library</string>
+    <string name="unable_add_pub_database">Unable to add publication to the database</string>
+    <string name="failed_parsing_catalog">Failed parsing Catalog</string>
+    <string name="next_chapter">Next chapter</string>
+    <string name="next_sentence">Next sentence</string>
+    <string name="play_and_pause">Play and pause</string>
+    <string name="previous_sentence">Previous sentence</string>
+    <string name="previous_chapter">Previous chapter</string>
+    <string name="brightness_lower">Brightness lower</string>
+    <string name="brightness_higher">Brightness higher</string>
+    <string name="tts_slower">TTS slower</string>
+    <string name="tts_faster">TTS faster</string>
+    <string name="no_result">No result</string>
+    <string name="note">Note</string>
+    <string name="add_a_note">Add a note</string>
+    <string name="add_an_annotation">Add an annotation</string>
+    <string name="delete_highlight_or_annotation">Delete highlight or annotation</string>
+    <string name="yellow">Yellow</string>
+    <string name="green">Green</string>
+    <string name="blue">Blue</string>
+    <string name="red">Red</string>
+    <string name="purple">Purple</string>
+    <string name="seek_bar">Seek bar</string>
+    <string name="go_backward_30_seconds">Go backward 30 seconds</string>
+    <string name="play_or_pause">Play or pause</string>
+    <string name="go_forward_30_seconds">Go forward 30 seconds</string>
+    <string name="select_a_font">Select a font</string>
+</resources>

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

@@ -0,0 +1,46 @@
+<!--
+  ~ Module: r2-testapp-kotlin
+  ~ Developers: Aferdita Muriqi, Clément Baumann
+  ~
+  ~ Copyright (c) 2018. European Digital Reading Lab. All rights reserved.
+  ~ Licensed to the Readium Foundation under one or more contributor license agreements.
+  ~ 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.
+  -->
+
+<resources>
+
+    <!-- Base application theme. -->
+    <style name="AppTheme" parent="Theme.MaterialComponents.Light.DarkActionBar">
+        <!-- Customize your theme here. -->
+        <item name="colorPrimary">@color/colorPrimary</item>
+        <item name="colorPrimaryDark">@color/colorPrimaryDark</item>
+        <item name="colorAccent">@color/colorAccentPrefs</item>
+        <item name="android:popupAnimationStyle">@null</item>
+        <item name="colorSurface">@color/white</item>
+        <item name="floatingActionButtonStyle">@style/Widget.App.FloatingActionButton</item>
+    </style>
+
+    <style name="AppTheme.NoActionBar">
+        <item name="windowActionBar">false</item>
+        <item name="windowNoTitle">true</item>
+        <item name="android:popupAnimationStyle">@null</item>
+
+    </style>
+
+    <style name="TabWidgetTheme" parent="AppTheme">
+        <item name="android:textSize">10sp</item>
+        <item name="android:textAlignment">center</item>
+    </style>
+
+    <style name="Widget.App.FloatingActionButton" parent="Widget.MaterialComponents.FloatingActionButton">
+        <item name="materialThemeOverlay">@style/ThemeOverlay.App.FloatingActionButton</item>
+    </style>
+
+    <style name="ThemeOverlay.App.FloatingActionButton" parent="">
+        <item name="colorSecondary">@color/colorPrimary</item>
+        <item name="colorOnSecondary">@color/white</item>
+        <item name="colorOnSurface">@color/colorPrimary</item>
+    </style>
+
+</resources>

package/android/src/main/res/xml/network_security_config.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<network-security-config>
+    <domain-config cleartextTrafficPermitted="true">
+
+        <!--
+        Required with r2-navigator-kotlin
+        Used to serve a publication's resources from the local HTTP server
+        -->
+        <domain includeSubdomains="false">127.0.0.1</domain>
+        <domain includeSubdomains="false">localhost</domain>
+
+        <!--
+        Required with r2-lcp-kotlin
+        The CRL is served from an HTTP server, so we need to explicitly allow clear-text traffic on
+        this domain
+        See https://github.com/readium/r2-lcp-kotlin/issues/59
+        -->
+        <domain includeSubdomains="false">crl.edrlab.telesec.de</domain>
+
+        <!-- Publications from Feedbooks' catalog are downloaded through HTTP -->
+        <domain includeSubdomains="true">feedbooks.com</domain>
+        <domain includeSubdomains="true">feedbooks.net</domain>
+
+        <!--
+        Required for the Open Textbooks Catalog OPDS feed to load properly
+        open.minitex.org is for the publications
+        s3.amazonaws.com is for the cover images
+        -->
+        <domain includeSubdomains="false">open.minitex.org</domain>
+        <domain includeSubdomains="false">s3.amazonaws.com</domain>
+
+        <!--
+        Required to stream the Flatland audiobook sample.
+        -->
+        <domain includeSubdomains="true">archive.org</domain>
+
+    </domain-config>
+</network-security-config>

package/ios/App/AppModule.swift

@@ -0,0 +1,62 @@
+import Combine
+import Foundation
+import UIKit
+import R2Shared
+import R2Streamer
+
+
+/// Base module delegate, that sub-modules' delegate can extend.
+/// Provides basic shared functionalities.
+protocol ModuleDelegate: AnyObject {
+  func presentAlert(_ title: String, message: String, from viewController: UIViewController)
+  func presentError(_ error: Error?, from viewController: UIViewController)
+}
+
+
+/// Main application module, it:
+/// - owns the sub-modules (reader, etc.)
+/// - orchestrates the communication between its sub-modules, through the modules' delegates.
+final class AppModule {
+
+  // App modules
+  var reader: ReaderModuleAPI! = nil
+  // var opds: OPDSModuleAPI! = nil
+
+  init() throws {
+    guard let server = PublicationServer() else {
+      /// FIXME: we should recover properly if the publication server can't start, maybe this should only forbid opening a publication?
+      fatalError("Can't start publication server")
+    }
+
+    reader = ReaderModule(delegate: self, resourcesServer: server)
+    // opds = OPDSModule(delegate: self)
+
+    // Set Readium 2's logging minimum level.
+    R2EnableLog(withMinimumSeverityLevel: .debug)
+  }
+}
+
+
+extension AppModule: ModuleDelegate {
+
+  func presentAlert(_ title: String, message: String, from viewController: UIViewController) {
+    let alert = UIAlertController(title: title, message: message, preferredStyle: .alert)
+    let dismissButton = UIAlertAction(title: NSLocalizedString("ok_button", comment: "Alert button"), style: .cancel)
+    alert.addAction(dismissButton)
+    viewController.present(alert, animated: true)
+  }
+
+  func presentError(_ error: Error?, from viewController: UIViewController) {
+    guard let error = error else { return }
+    if case ReaderError.cancelled = error { return }
+    presentAlert(
+      NSLocalizedString("error_title", comment: "Alert title for errors"),
+      message: error.localizedDescription,
+      from: viewController
+    )
+  }
+
+}
+
+
+extension AppModule: ReaderModuleDelegate {}

package/ios/Common/Paths.swift

@@ -0,0 +1,52 @@
+import Combine
+import Foundation
+import R2Shared
+
+final class Paths {
+  private init() {}
+
+  static let home: URL =
+    URL(fileURLWithPath: NSHomeDirectory(), isDirectory: true)
+
+  static let temporary: URL =
+    URL(fileURLWithPath: NSTemporaryDirectory(), isDirectory: true)
+
+  static let documents: URL =
+    FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
+
+  static let samples = Bundle.main.resourceURL!.appendingPathComponent("Samples")
+
+  static let library: URL =
+    FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first!
+
+  static let covers: URL = {
+    let url = library.appendingPathComponent("Covers")
+    try! FileManager.default.createDirectory(at: url, withIntermediateDirectories: true)
+    return url
+  }()
+
+  static func makeDocumentURL(for source: URL? = nil, title: String?, mediaType: MediaType) -> AnyPublisher<URL, Never> {
+    Future(on: .global()) { promise in
+      // Is the file already in Documents/?
+      if let source = source, source.standardizedFileURL.deletingLastPathComponent() == documents.standardizedFileURL {
+        promise(.success(source))
+      } else {
+        let title = title.takeIf { !$0.isEmpty } ?? UUID().uuidString
+        let ext = mediaType.fileExtension?.addingPrefix(".") ?? ""
+        let filename = "\(title)\(ext)".sanitizedPathComponent
+        promise(.success(documents.appendingUniquePathComponent(filename)))
+      }
+    }.eraseToAnyPublisher()
+  }
+
+  static func makeTemporaryURL() -> AnyPublisher<URL, Never> {
+    Future(on: .global()) { promise in
+      promise(.success(temporary.appendingUniquePathComponent()))
+    }.eraseToAnyPublisher()
+  }
+
+  /// Returns whether the given `url` locates a file that is under the app's home directory.
+  static func isAppFile(at url: URL) -> Bool {
+    home.isParentOf(url)
+  }
+}

package/ios/Common/Publication.swift

@@ -0,0 +1,15 @@
+import CoreServices
+import Foundation
+import R2Shared
+
+extension Publication {
+
+  /// Finds all the downloadable links for this publication.
+  var downloadLinks: [Link] {
+    links.filter {
+      return DocumentTypes.main.supportsMediaType($0.type)
+        || DocumentTypes.main.supportsFileExtension($0.url(relativeTo: nil)?.pathExtension)
+    }
+  }
+
+}

package/ios/Common/Toolkit/Extensions/AnyPublisher.swift

@@ -0,0 +1,14 @@
+import Combine
+
+extension AnyPublisher {
+
+  public static func just(_ value: Output) -> Self {
+    Just(value)
+      .setFailureType(to: Failure.self)
+      .eraseToAnyPublisher()
+  }
+
+  public static func fail(_ error: Failure) -> Self {
+    Fail(error: error).eraseToAnyPublisher()
+  }
+}

package/ios/Common/Toolkit/Extensions/Future.swift

@@ -0,0 +1,16 @@
+import Combine
+import Foundation
+
+extension Future {
+  /// Creates a `Future` which runs asynchronously on the given `queue`.
+  public convenience init(
+    on queue: DispatchQueue,
+    _ attemptToFulfill: @escaping (@escaping Future<Output, Failure>.Promise) -> Void
+  ) {
+    self.init { promise in
+      queue.async {
+        attemptToFulfill(promise)
+      }
+    }
+  }
+}

package/ios/Common/Toolkit/Extensions/HTTPClient.swift

@@ -0,0 +1,65 @@
+import Combine
+import Foundation
+import R2Shared
+
+struct HTTPDownload {
+  let file: URL
+  let response: HTTPResponse
+}
+
+extension HTTPClient {
+
+  func fetch(_ request: HTTPRequestConvertible) -> AnyPublisher<HTTPResponse, HTTPError> {
+    var cancellable: R2Shared.Cancellable? = nil
+    return Future { promise in
+      cancellable = self.fetch(request, completion: promise)
+    }
+    .handleEvents(receiveCancel: { cancellable?.cancel() })
+    .eraseToAnyPublisher()
+  }
+
+  func download(_ request: HTTPRequestConvertible, progress: @escaping (Double) -> Void) -> AnyPublisher<HTTPDownload, HTTPError> {
+    openTemporaryFileForWriting()
+      .flatMap { (destination, handle) -> AnyPublisher<HTTPDownload, HTTPError> in
+        var cancellable: R2Shared.Cancellable? = nil
+
+        return Future { promise in
+          cancellable = self.stream(request,
+            consume: { data, progression in
+              if let progression = progression {
+                progress(progression)
+              }
+              handle.write(data)
+            },
+            completion: { result in
+              do {
+                try handle.close()
+                promise(.success(HTTPDownload(file: destination, response: try result.get())))
+              } catch {
+                try? FileManager.default.removeItem(at: destination)
+                promise(.failure(HTTPError(error: error)))
+              }
+            })
+        }
+        .handleEvents(receiveCancel: {
+          cancellable?.cancel()
+          try? handle.close()
+          try? FileManager.default.removeItem(at: destination)
+        })
+        .eraseToAnyPublisher()
+      }
+      .eraseToAnyPublisher()
+  }
+
+  private func openTemporaryFileForWriting() -> AnyPublisher<(URL, FileHandle), HTTPError> {
+    Paths.makeTemporaryURL()
+      .tryMap { destination in
+        // Makes sure the file exists.
+        try "".write(to: destination, atomically: true, encoding: .utf8)
+        let handle = try FileHandle(forWritingTo: destination)
+        return (destination, handle)
+      }
+      .mapError { HTTPError(kind: .other, cause: $0) }
+      .eraseToAnyPublisher()
+  }
+}

package/ios/Common/Toolkit/Extensions/Locator.swift

@@ -0,0 +1,14 @@
+import Foundation
+import R2Shared
+
+extension Locator: Codable {
+  public init(from decoder: Decoder) throws {
+    let json = try decoder.singleValueContainer().decode(String.self)
+    try self.init(jsonString: json)!
+  }
+
+  public func encode(to encoder: Encoder) throws {
+    var container = encoder.singleValueContainer()
+    try container.encode(jsonString)
+  }
+}

package/ios/Common/Toolkit/Extensions/String.swift

@@ -0,0 +1,16 @@
+import Foundation
+
+extension String {
+
+  /// Returns this string after removing any character forbidden in a single path component.
+  var sanitizedPathComponent: String {
+    // See https://superuser.com/a/358861
+    let invalidCharacters = CharacterSet(charactersIn: "\\/:*?\"<>|")
+      .union(.newlines)
+      .union(.illegalCharacters)
+      .union(.controlCharacters)
+
+    return components(separatedBy: invalidCharacters)
+      .joined(separator: " ")
+  }
+}

package/ios/Common/Toolkit/Extensions/UIImage.swift

@@ -0,0 +1,12 @@
+import UIKit
+
+/// SO 33545910/1585121 - Heberti Almeida (inspired).
+extension UIImage {
+  class func imageWithTextView(textView: UITextView) -> UIImage {
+    UIGraphicsBeginImageContextWithOptions(textView.bounds.size, false, 0.0)
+    textView.layer.render(in: UIGraphicsGetCurrentContext()!)
+    let image = UIGraphicsGetImageFromCurrentImageContext()
+    UIGraphicsEndImageContext()
+    return image!
+  }
+}

package/ios/Common/Toolkit/Extensions/UIViewController.swift

@@ -0,0 +1,19 @@
+import Foundation
+import UIKit
+
+extension UIViewController {
+
+  /// Finds the first child view controller with the given type, recursively.
+  func findChildViewController<T: UIViewController>() -> T? {
+    for childViewController in children {
+      if let found = childViewController as? T {
+        return found
+      }
+      if let found: T = childViewController.findChildViewController() {
+        return found
+      }
+    }
+    return nil
+  }
+
+}

package/ios/Common/Toolkit/ScreenOrientation.swift

@@ -0,0 +1,13 @@
+import Foundation
+import UIKit
+
+enum ScreenOrientation: String {
+  case landscape
+  case portrait
+
+  static var current: ScreenOrientation {
+    let orientation = UIDevice.current.orientation
+    return orientation.isLandscape ? .landscape : .portrait
+  }
+
+}

package/ios/Data/Bookmark.swift

@@ -0,0 +1,23 @@
+import Combine
+import Foundation
+import R2Shared
+
+struct Bookmark {
+  let id: String?
+  /// Foreign key to the publication.
+  var bookId: String
+  /// Location in the publication.
+  var locator: Locator
+  /// Progression in the publication, extracted from the locator.
+  var progression: Double?
+  /// Date of creation.
+  var created: Date = Date()
+
+  init(id: String? = nil, bookId: String, locator: Locator, created: Date = Date()) {
+    self.id = id
+    self.bookId = bookId
+    self.locator = locator
+    self.progression = locator.locations.totalProgression
+    self.created = created
+  }
+}