2.4.0

Take a look at the migration guide

Added

Shared

• Support for the accessibility metadata in RWPM per Schema.org Accessibility Properties for Discoverability Vocabulary.
• Extract the raw content (text, images, etc.) of a publication.

Navigator

• A brand new text-to-speech implementation.

Streamer

• Parse EPUB accessibility metadata (see documentation).

Deprecated

Shared

• Locator(link: Link) is deprecated as it may create an incorrect Locator if the link type is missing.
  • Use publication.locate(Link) instead.

Fixed

• #244 Fixed build with Xcode 14 and Carthage/CocoaPods.

Navigator

• Fixed memory leaks in the EPUB and PDF navigators.
• #61 Fixed serving EPUB resources when the HREF contains an anchor or query parameters.
• Performance issue with EPUB fixed-layout when spreads are enabled.
• Disable scrolling in EPUB fixed-layout resources, in case the viewport is incorrectly set.
• Fix vertically bouncing EPUB resources in iOS 16.

Streamer

• Fixed memory leak in the PublicationServer.

LCP

• The LCP authentication dialog is now fully localized and supports Dark Mode (contributed by @openm1nd).

2.3.0

Take a look at the migration guide

Added

Shared

• Get the sanitized Locator text ready for user display with locator.text.sanitized().
• A new Publication.conforms(to:) API to identify the profile of a publication.
• Support for the conformsTo RWPM metadata, to identify the profile of a Publication.
• Support for right-to-left PDF documents by extracting the reading progression from the ViewerPreferences/Direction metadata.
• HTTP client:
  • A new HTTPClient.download() API to download HTTP resources to a temporary location.
  • HTTPRequest and DefaultHTTPClient take an optional userAgent property to customize the user agent.

Navigator

• The new NavigatorDelegate.navigator(_:didJumpTo:) API is called every time the navigator jumps to an explicit location, which might break the linear reading progression.
  • For example, it is called when clicking on internal links or programmatically calling Navigator.go(to:), but not when turning pages.
  • You can use this callback to implement a navigation history by differentiating between continuous and discontinuous moves.

Deprecated

Shared

• Publication.format is now deprecated in favor of the new Publication.conforms(to:) API which is more accurate.
  • For example, replace publication.format == .epub with publication.conforms(to: .epub) before opening a publication with the EPUBNavigatorViewController.

Changed

LCP

• The LCPService now uses a provided HTTPClient instance for all HTTP requests.

Fixed

Navigator

• #14 Backward compatibility (iOS 10+) of JavaScript files is now handled with Babel.
• Throttle the reload of EPUB spreads to avoid losing the position when the reader gets back to the foreground.

LCP

• Fixed the notification of acquisition progress.

2.2.0

Take a look at the migration guide

Added

Shared

• Support for Paragraph Margins user setting.

Navigator

• A new translate EPUB and PDF editing action is available for iOS 15.

Fixed

Shared

• Improved performances of the search service used with EPUB.

Navigator

• Fixed turning pages of an EPUB reflowable resource with an odd number of columns. A virtual blank trailing column is appended to the resource when displayed as two columns.