react-native-readium 4.0.2 → 5.0.0-rc.1

package/ios/Reader/Common/ReaderViewController.swift

@@ -1,12 +1,11 @@
 import Combine
 import SafariServices
 import UIKit
-import R2Navigator
-import R2Shared
+import ReadiumNavigator
+import ReadiumShared
 import SwiftSoup
 import WebKit
 
-
 /// This class is meant to be subclassed by each publication format view controller. It contains the shared behavior, eg. navigation bar toggling.
 class ReaderViewController: UIViewController, Loggable {
 
@@ -19,8 +18,12 @@ class ReaderViewController: UIViewController, Loggable {
   private(set) var stackView: UIStackView!
   private lazy var positionLabel = UILabel()
   private var subscriptions = Set<AnyCancellable>()
-  private var subject = PassthroughSubject<Locator, Never>()
+  private var subject = PassthroughSubject<ReadiumShared.Locator, Never>()
   lazy var publisher = subject.eraseToAnyPublisher()
+  private var positionsCount: Int?
+  private var positionsLoadingTask: Task<Void, Never>?
+  private var lastKnownLocator: ReadiumShared.Locator?
+  private var navigatorInputObserverTokens = Set<InputObservableToken>()
 
   /// This regex matches any string with at least 2 consecutive letters (not limited to ASCII).
   /// It's used when evaluating whether to display the body of a noteref referrer as the note's title.
@@ -55,6 +58,8 @@ class ReaderViewController: UIViewController, Loggable {
 
   deinit {
     NotificationCenter.default.removeObserver(self)
+    positionsLoadingTask?.cancel()
+    removeNavigatorInputObservers()
   }
 
   override func viewDidLoad() {
@@ -93,6 +98,8 @@ class ReaderViewController: UIViewController, Loggable {
       positionLabel.centerXAnchor.constraint(equalTo: view.centerXAnchor),
       positionLabel.bottomAnchor.constraint(equalTo: navigator.view.bottomAnchor, constant: -20)
     ])
+
+    configureNavigatorInteractions()
   }
 
   override func willMove(toParent parent: UIViewController?) {
@@ -129,34 +136,6 @@ class ReaderViewController: UIViewController, Loggable {
   }
 
 
-  // MARK: - Locations
-  /// FIXME: This should be implemented in a shared Navigator interface, using Locators.
-
-  var currentBookmark: Bookmark? {
-    fatalError("Not implemented")
-  }
-
-  // MARK: - Bookmarks
-
-  @objc func bookmarkCurrentPosition() {
-    // guard let bookmark = currentBookmark else {
-    //   return
-    // }
-
-    // TODO: this should call a react callback
-    // bookmarks.add(bookmark)
-    //   .sink { completion in
-    //     switch completion {
-    //     case .finished:
-    //       toast(NSLocalizedString("reader_bookmark_success_message", comment: "Success message when adding a bookmark"), on: self.view, duration: 1)
-    //     case .failure(let error):
-    //       print(error)
-    //       toast(NSLocalizedString("reader_bookmark_failure_message", comment: "Error message when adding a new bookmark failed"), on: self.view, duration: 2)
-    //     }
-    //   } receiveValue: { _ in }
-    //   .store(in: &subscriptions)
-  }
-
   // MARK: - Accessibility
 
   /// Constraint used to shift the content under the navigation bar, since it is always visible when VoiceOver is running.
@@ -205,28 +184,74 @@ class ReaderViewController: UIViewController, Loggable {
     updateNavigationBar()
   }
 
+  private func configureNavigatorInteractions() {
+    guard let visualNavigator = navigator as? VisualNavigator else {
+      return
+    }
+
+    guard navigatorInputObserverTokens.isEmpty else {
+      return
+    }
+
+    DirectionalNavigationAdapter(
+      pointerPolicy: .init(edges: .all),
+      animatedTransition: true
+    ).bind(to: visualNavigator)
+
+    let toggleToken = visualNavigator.addObserver(.tap { [weak self] event in
+      guard
+        let self,
+        event.phase != .cancel
+      else {
+        return false
+      }
+
+      self.toggleNavigationBar()
+      return true
+    })
+    toggleToken.store(in: &navigatorInputObserverTokens)
+  }
+
+  private func removeNavigatorInputObservers() {
+    guard
+      let visualNavigator = navigator as? VisualNavigator
+    else {
+      navigatorInputObserverTokens.removeAll()
+      return
+    }
+
+    navigatorInputObserverTokens.forEach { visualNavigator.removeObserver($0) }
+    navigatorInputObserverTokens.removeAll()
+  }
+
   @objc private func goBackward() {
-    navigator.goBackward()
+    Task { [weak self] in
+      await self?.navigateBackwardAnimated()
+    }
   }
 
   @objc private func goForward() {
-    navigator.goForward()
+    Task { [weak self] in
+      await self?.navigateForwardAnimated()
+    }
+  }
+
+  @MainActor
+  private func navigateBackwardAnimated() async {
+    _ = await navigator.goBackward(options: .animated)
+  }
+
+  @MainActor
+  private func navigateForwardAnimated() async {
+    _ = await navigator.goForward(options: .animated)
   }
 
 }
 
 extension ReaderViewController: NavigatorDelegate {
-  func navigator(_ navigator: Navigator, locationDidChange locator: Locator) {
+  func navigator(_ navigator: Navigator, locationDidChange locator: ReadiumShared.Locator) {
     subject.send(locator)
-    positionLabel.text = {
-      if let position = locator.locations.position {
-        return "\(position) / \(publication.positions.count)"
-      } else if let progression = locator.locations.totalProgression {
-        return "\(progression)%"
-      } else {
-        return nil
-      }
-    }()
+    updatePositionLabel(with: locator)
   }
 
   func navigator(_ navigator: Navigator, presentExternalURL url: URL) {
@@ -241,7 +266,7 @@ extension ReaderViewController: NavigatorDelegate {
     moduleDelegate?.presentError(error, from: self)
   }
 
-  func navigator(_ navigator: Navigator, shouldNavigateToNoteAt link: Link, content: String, referrer: String?) -> Bool {
+  func navigator(_ navigator: Navigator, shouldNavigateToNoteAt link: ReadiumShared.Link, content: String, referrer: String?) -> Bool {
 
     var title = referrer
     if let t = title {
@@ -288,16 +313,59 @@ extension ReaderViewController: NavigatorDelegate {
 
 }
 
-extension ReaderViewController: VisualNavigatorDelegate {
+extension ReaderViewController {
+  private func updatePositionLabel(with locator: ReadiumShared.Locator) {
+    lastKnownLocator = locator
+    positionLabel.text = positionLabelText(for: locator)
+  }
+
+  private func positionLabelText(for locator: ReadiumShared.Locator) -> String? {
+    if let position = locator.locations.position {
+      if let total = positionsCount {
+        return "\(position) / \(total)"
+      } else {
+        loadPositionsCountIfNeeded()
+        return "\(position)"
+      }
+    } else if let progression = locator.locations.totalProgression {
+      return "\(progression)%"
+    } else {
+      return nil
+    }
+  }
+
+  private func loadPositionsCountIfNeeded() {
+    guard positionsCount == nil else {
+      return
+    }
+    guard positionsLoadingTask == nil else {
+      return
+    }
+
+    positionsLoadingTask = Task { [weak self] in
+      guard let self else { return }
+      defer { self.positionsLoadingTask = nil }
 
-    func navigator(_ navigator: VisualNavigator, didTapAt point: CGPoint) {
-        let moved = DirectionalNavigationAdapter(navigator: navigator).didTap(at: point)
-        if !moved {
-            toggleNavigationBar()
+      let result = await self.publication.positions()
+      guard !Task.isCancelled else { return }
+
+      switch result {
+      case let .success(positions):
+        await MainActor.run {
+          self.positionsCount = positions.count
+          self.refreshPositionLabel()
         }
+      case let .failure(error):
+        self.log(.error, "Failed to load publication positions: \(error)")
+      }
     }
-    
-    func navigator(_ navigator: VisualNavigator, didPressKey event: KeyEvent) {
-        DirectionalNavigationAdapter(navigator: navigator).didPressKey(event: event)
+  }
+
+  @MainActor
+  private func refreshPositionLabel() {
+    guard let locator = lastKnownLocator else {
+      return
     }
+    positionLabel.text = positionLabelText(for: locator)
+  }
 }

package/ios/Reader/EPUB/AssociatedColors.swift

@@ -1,5 +1,5 @@
 import UIKit
-import R2Navigator
+import ReadiumNavigator
 
 class AssociatedColors {
 

package/ios/Reader/EPUB/EPUBHTTPServer.swift

@@ -0,0 +1,13 @@
+import Foundation
+import ReadiumShared
+import ReadiumAdapterGCDWebServer
+
+/// Provides a shared HTTP server backed by GCDWebServer for EPUB resources.
+enum EPUBHTTPServer {
+    /// Lazily instantiated HTTP server reused across EPUB reader sessions.
+    static let shared: GCDHTTPServer = {
+        let httpClient = DefaultHTTPClient()
+        let assetRetriever = AssetRetriever(httpClient: httpClient)
+        return GCDHTTPServer(assetRetriever: assetRetriever)
+    }()
+}

package/ios/Reader/EPUB/EPUBModule.swift

@@ -1,7 +1,6 @@
 import Foundation
 import UIKit
-import R2Shared
-
+import ReadiumShared
 
 final class EPUBModule: ReaderFormatModule {
 
@@ -18,8 +17,9 @@ final class EPUBModule: ReaderFormatModule {
 
     func makeReaderViewController(
       for publication: Publication,
-      locator: Locator?,
-      bookId: String
+      locator: ReadiumShared.Locator?,
+      bookId: String,
+      selectionActions: [SelectionActionData]?
     ) throws -> ReaderViewController {
         guard publication.metadata.identifier != nil else {
             throw ReaderError.epubNotValid
@@ -28,7 +28,8 @@ final class EPUBModule: ReaderFormatModule {
         let epubViewController = try EPUBViewController(
             publication: publication,
             locator: locator,
-            bookId: bookId
+            bookId: bookId,
+            selectionActions: selectionActions
         )
         epubViewController.moduleDelegate = delegate
         return epubViewController

package/ios/Reader/EPUB/EPUBViewController.swift

@@ -1,19 +1,57 @@
 import UIKit
-import R2Shared
-import R2Navigator
-import ReadiumAdapterGCDWebServer
+import ReadiumShared
+import ReadiumNavigator
 
-class EPUBViewController: ReaderViewController {
+struct SelectionActionData: Codable {
+    let id: String
+    let label: String
+}
+
+protocol SelectionActionDelegate: AnyObject {
+    func onSelectionAction(actionId: String, locator: ReadiumShared.Locator, selectedText: String)
+}
+
+class EPUBViewController: ReaderViewController, SelectionActionHandlerDelegate {
+    private var selectionActionHandler: SelectionActionHandler?
+    weak var selectionActionDelegate: SelectionActionDelegate?
 
     init(
       publication: Publication,
-      locator: Locator?,
-      bookId: String
+      locator: ReadiumShared.Locator?,
+      bookId: String,
+      selectionActions: [SelectionActionData]? = nil
     ) throws {
+      // Convert typed selection actions directly to EditingActions (no JSON)
+      var editingActions: [EditingAction] = []
+      var actionIds: [String] = []
+
+      if let actions = selectionActions {
+        for action in actions {
+          actionIds.append(action.id)
+
+          let selectorName = "handleSelectionAction_\(action.id):"
+          let selector = NSSelectorFromString(selectorName)
+
+          editingActions.append(EditingAction(
+            title: action.label,
+            action: selector
+          ))
+        }
+      }
+
+      // Only use custom actions - don't add default iOS actions
+      // If no custom actions are provided, use defaults as fallback
+      if editingActions.isEmpty {
+        editingActions.append(contentsOf: EditingAction.defaultActions)
+      }
+
       let navigator = try EPUBNavigatorViewController(
         publication: publication,
         initialLocation: locator,
-        httpServer: GCDHTTPServer.shared
+        config: EPUBNavigatorViewController.Configuration(
+          editingActions: editingActions
+        ),
+        httpServer: EPUBHTTPServer.shared
       )
 
       super.init(
@@ -22,6 +60,13 @@ class EPUBViewController: ReaderViewController {
         bookId: bookId
       )
 
+      // Set up the Objective-C handler for dynamic methods
+      if !actionIds.isEmpty {
+        let handler = SelectionActionHandler(actionIds: actionIds)
+        handler.delegate = self
+        selectionActionHandler = handler
+      }
+
       navigator.delegate = self
     }
 
@@ -29,6 +74,12 @@ class EPUBViewController: ReaderViewController {
       return navigator as! EPUBNavigatorViewController
     }
 
+    func updateSelectionActions(_ selectionActions: [SelectionActionData]?) {
+      // On iOS, selection actions must be set during navigator initialization
+      // Dynamic updates would require recreating the navigator, which we don't support yet
+      print("Warning: Updating selection actions after initialization is not supported on iOS")
+    }
+
     override func viewDidLoad() {
       super.viewDidLoad()
 
@@ -36,6 +87,36 @@ class EPUBViewController: ReaderViewController {
       setUIColor(for: epubNavigator.settings.theme)
     }
 
+    // Insert handler into the responder chain
+    override var next: UIResponder? {
+      if let handler = selectionActionHandler {
+        // Set the handler's next responder to continue the chain
+        handler.originalNextResponder = super.next
+        return handler
+      }
+      return super.next
+    }
+
+    // SelectionActionHandlerDelegate implementation
+    func handleSelectionAction(withId actionId: String) {
+      guard let navigator = navigator as? EPUBNavigatorViewController else {
+        return
+      }
+
+      guard let selection = navigator.currentSelection else {
+        return
+      }
+
+      selectionActionDelegate?.onSelectionAction(
+        actionId: actionId,
+        locator: selection.locator,
+        selectedText: selection.locator.text.highlight ?? ""
+      )
+
+      // Clear the selection
+      navigator.clearSelection()
+    }
+
     internal func setUIColor(for theme: Theme) {
       let colors = AssociatedColors.getColors(for: theme)
 
@@ -48,14 +129,6 @@ class EPUBViewController: ReaderViewController {
       navigationController?.navigationBar.titleTextAttributes = [NSAttributedString.Key.foregroundColor: colors.textColor]
     }
 
-    override var currentBookmark: Bookmark? {
-      guard let locator = navigator.currentLocation else {
-        return nil
-      }
-
-      return Bookmark(bookId: bookId, locator: locator)
-    }
-
 }
 
 extension EPUBViewController: EPUBNavigatorDelegate {}

package/ios/Reader/EPUB/SelectionActionHandler.h

@@ -0,0 +1,25 @@
+//
+//  SelectionActionHandler.h
+//  react-native-readium
+//
+
+#import <UIKit/UIKit.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol SelectionActionHandlerDelegate <NSObject>
+- (void)handleSelectionActionWithId:(NSString *)actionId;
+@end
+
+/// Helper class to handle dynamic selection actions using Objective-C runtime
+/// This needs to be a UIResponder to be part of the responder chain
+@interface SelectionActionHandler : UIResponder
+
+@property (nonatomic, weak) id<SelectionActionHandlerDelegate> delegate;
+@property (nonatomic, strong, nullable) UIResponder *originalNextResponder;
+
+- (instancetype)initWithActionIds:(NSArray<NSString *> *)actionIds;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/ios/Reader/EPUB/SelectionActionHandler.m

@@ -0,0 +1,56 @@
+//
+//  SelectionActionHandler.m
+//  react-native-readium
+//
+
+#import "SelectionActionHandler.h"
+#import <objc/runtime.h>
+
+@interface SelectionActionHandler ()
+@property (nonatomic, strong) NSArray<NSString *> *actionIds;
+@end
+
+@implementation SelectionActionHandler
+
+- (instancetype)initWithActionIds:(NSArray<NSString *> *)actionIds {
+    self = [super init];
+    if (self) {
+        _actionIds = actionIds;
+        [self setupDynamicMethods];
+    }
+    return self;
+}
+
+- (void)setupDynamicMethods {
+    Class class = [self class];
+
+    for (NSString *actionId in self.actionIds) {
+        NSString *selectorName = [NSString stringWithFormat:@"handleSelectionAction_%@:", actionId];
+        SEL selector = NSSelectorFromString(selectorName);
+
+        // Create the implementation
+        IMP implementation = imp_implementationWithBlock(^(id _self, id sender) {
+            SelectionActionHandler *handler = (SelectionActionHandler *)_self;
+            [handler.delegate handleSelectionActionWithId:actionId];
+        });
+
+        // Add the method to the class
+        // Method signature: void (id self, SEL _cmd, id sender)
+        class_addMethod(class, selector, implementation, "v@:@");
+    }
+}
+
+- (BOOL)respondsToSelector:(SEL)aSelector {
+    NSString *selectorString = NSStringFromSelector(aSelector);
+    if ([selectorString hasPrefix:@"handleSelectionAction_"]) {
+        return YES;
+    }
+    return [super respondsToSelector:aSelector];
+}
+
+- (UIResponder *)nextResponder {
+    // Return the original next responder to continue the chain
+    return self.originalNextResponder;
+}
+
+@end

package/ios/Reader/ReaderFormatModule.swift

@@ -1,7 +1,6 @@
 import Foundation
 import UIKit
-import R2Shared
-
+import ReadiumShared
 
 /// A ReaderFormatModule is a sub-module of ReaderModule that handles publication of a given format (eg. EPUB, CBZ).
 protocol ReaderFormatModule {
@@ -14,8 +13,9 @@ protocol ReaderFormatModule {
   /// Creates the view controller to present the publication.
   func makeReaderViewController(
     for publication: Publication,
-    locator: Locator?,
-    bookId: String
+    locator: ReadiumShared.Locator?,
+    bookId: String,
+    selectionActions: [SelectionActionData]?
   ) throws -> ReaderViewController
 
 }

package/ios/Reader/ReaderModule.swift

@@ -1,7 +1,6 @@
 import Foundation
 import UIKit
-import R2Shared
-
+import ReadiumShared
 
 /// The ReaderModule handles the presentation of publications to be read by the user.
 /// It contains sub-modules implementing ReaderFormatModule to handle each format of publication (eg. CBZ, EPUB).
@@ -11,7 +10,8 @@ protocol ReaderModuleAPI {
   func getViewController(
     for publication: Publication,
     bookId: String,
-    locator: Locator?
+    locator: ReadiumShared.Locator?,
+    selectionActions: [SelectionActionData]?
   ) -> ReaderViewController?
 }
 
@@ -43,7 +43,8 @@ final class ReaderModule: ReaderModuleAPI {
   func getViewController(
     for publication: Publication,
     bookId: String,
-    locator: Locator?
+    locator: ReadiumShared.Locator?,
+    selectionActions: [SelectionActionData]?
   ) -> ReaderViewController? {
     guard let module = self.formatModules.first(
       where:{ $0.supports(publication) }
@@ -56,7 +57,8 @@ final class ReaderModule: ReaderModuleAPI {
       return try module.makeReaderViewController(
         for: publication,
         locator: locator,
-        bookId: bookId
+        bookId: bookId,
+        selectionActions: selectionActions
       )
     } catch {
       print("An unexpected error occurred when attempting to build the reader view.")