2.7.3

Take a look at the migration guide

Changelog

• #483 Fix build on Xcode 16.

What's Changed

• Fix build on Xcode 16 by @mickael-menu in #484
• 2.7.3 by @mickael-menu in #485

Full Changelog: 2.7.2...2.7.3

3.0.0-alpha.2

Take a look at the migration guide

Changelog

Added

Streamer

• Support for standalone audio files and their metadata (contributed by @domkm).

Changed

• The Readium Swift toolkit now requires a minimum of iOS 13.
• Plenty of completion-based APIs were changed to use async functions instead.

Shared

• A new Format type was introduced to augment MediaType with more precise information about the format specifications of an Asset.
• Fetcher was replaced with a simpler Container type.
• PublicationAsset was replaced by Asset, which contains a Format and access to the underlying Container or Resource.
• The ResourceError hierarchy was revamped and simplified (see ReadError). Now it is your responsibility to provide a localized user message for each error case.
• The Link property key for archive-based publication assets (e.g. an EPUB/ZIP) is now https://readium.org/webpub-manifest/properties#archive instead of archive.
• The API of HTTPServer slightly changed to be more future-proof.

Streamer

• The Streamer object was deprecated in favor of smaller segregated APIs: AssetRetriever and PublicationOpener.

Navigator

• EPUB: The scroll preference is now forced to true when rendering vertical text (e.g. CJK vertical). See this discussion for the rationale.

LCP

• The Readium LCP persistence layer was extracted to allow applications to provide their own implementations. Take a look at the migration guide for guidance.

Fixed

Navigator

• Optimized scrolling to an EPUB text-based locator if it contains a CSS selector.
• The first resource of a fixed-layout EPUB is now displayed on its own when spreads are enabled and the author has not set a page-spread-* property. This is the default behavior in major reading apps like Apple Books.
• #471 EPUB: Fixed reporting the current location when submitting new preferences.

What's Changed

• Rename archive Link property by @mickael-menu in #422
• Disable EPUB pagination with vertical text by @mickael-menu in #423
• Bump the minimum iOS version to 13 by @mickael-menu in #427
• Update HTTPServer API by @mickael-menu in #424
• Enhance AudioParser by @domkm in #414
• Remove / prefix for exploded archive HREFs by @mickael-menu in #432
• Optimize scrolling to an EPUB locator with a CSS selector by @mickael-menu in #435
• Allow to customize the LCP device name by @mickael-menu in #437
• Async HTTPClient and LCP APIs by @mickael-menu in #438
• Fix Test App using CocoaPods by @mickael-menu in #439
• Extract the LCP persistence layer by @mickael-menu in #442
• Handle URLs with aliases in ExplodedArchive by @domkm in #441
• Fix resolving search results title by @mickael-menu in #446
• Fixed editing actions on iOS 17 by @mickael-menu in #447
• 2.7.2 by @mickael-menu in #448
• First pass at marking types as Sendable by @domkm in #450
• Change localizedCaseInsensitiveCompare to localizedStandardCompare by @domkm in #451
• Improve URL equality by @mickael-menu in #453
• Normalize URLs on-the-fly when comparing by @mickael-menu in #454
• Fix first spread of FXL EPUBs by @mickael-menu in #470
• Fix reporting the current locator when submitting new preferences by @mickael-menu in #474
• Documentation for the v3 by @mickael-menu in #475
• Fix iOS 13 warnings by @mickael-menu in #476
• Extract localized error messages from the toolkit by @mickael-menu in #477

Full Changelog: 3.0.0-alpha.1...3.0.0-alpha.2

2.7.2

Take a look at the migration guide

Changelog

Fixed

Shared

• #444 Fixed resolving titles of search results when the table of contents items contain fragment identifiers.

Navigator

• #428 Fixed crash with the share editing action on iOS 17.
• #428 Fixed showing look up and translate editing actions on iOS 17.

What's Changed

• Fix resolving search results title by @mickael-menu in #446
• Fixed editing actions on iOS 17 by @mickael-menu in #447
• 2.7.2 by @mickael-menu in #448

Full Changelog: 2.7.1...2.7.2

3.0.0-alpha.1

Take a look at the migration guide

Changelog

Changed

• The R2Shared, R2Streamer and R2Navigator packages are now called ReadiumShared, ReadiumStreamer and ReadiumNavigator.
• Many APIs now expect one of the new URL types (RelativeURL, AbsoluteURL, HTTPURL and FileURL). This is helpful because:
  • It validates at compile time that we provide a URL that is supported.
  • The API's capabilities are better documented, e.g. a download API could look like this : download(url: HTTPURL) -> FileURL.

Shared

• Link and Locator's href are normalized as valid URLs to improve interoperability with the Readium Web toolkits.
  • You MUST migrate your database if you were persisting HREFs and Locators. Take a look at the migration guide for guidance.
• Links are not resolved to the self URL of a manifest anymore. However, you can still normalize the HREFs yourselves by calling Manifest.normalizeHREFsToSelf().
• Publication.localizedTitle is now optional, as we cannot guarantee a publication will always have a title.

What's Changed

• Refactor HREF normalization and models by @mickael-menu in #358
• Validate Link's href when creating a URL by @mickael-menu in #379
• Fix audiobook regression by @mickael-menu in #380
• Prevent crash when reporting the currently spoken word by @mickael-menu in #381
• Validate Link HREFs only when they are not templated by @mickael-menu in #387
• Fix audiobook regression by @mickael-menu in #393
• Drop R2 prefix by @mickael-menu in #412
• Don't require a self link to enable HTTP requests in a RWPM by @mickael-menu in #415
• Documentation by @mickael-menu in #384
• 3.0.0-alpha.1 by @mickael-menu in #420

Full Changelog: 2.7.1...3.0.0-alpha.1

2.7.1

Take a look at the migration guide

Changelog

Added

LCP

• #417 Support for the new 2.x LCP Profiles.

What's Changed

• Support for the new 2.x LCP Profiles by @mickael-menu in #418
• 2.7.1 by @mickael-menu in #419

Full Changelog: 2.7.0...2.7.1

2.7.0

Take a look at the migration guide

Changelog

Added

Shared

• You can now use DefaultHTTPClientDelegate.httpClient(_:request:didReceive:completion:) to handle authentication challenges (e.g. Basic) with DefaultHTTPClient.

Navigator

• The AudioNavigator API has been promoted to stable and ships with a new Preferences API.
• The new NavigatorDelegate.didFailToLoadResourceAt(_:didFailToLoadResourceAt:withError:) delegate API notifies when an error occurs while loading a publication resource (contributed by @ettore).

Fixed

• #390 Fixed logger not logging above the minimum severity level (contributed by @ettore).

Navigator

• From iOS 13 to 15, PDF text selection is disabled on protected publications disabling the Copy editing action.
• The Share editing action is disabled for any protected publication.
• Fixed starting the TTS from the current EPUB position.
• #396 Ensure we stop the activity indicator when an EPUB resource fails to load correctly (contributed by @ettore).

Streamer

• #399 Zipped Audio Books and standalone audio files are now recognized.

Commits

• Adjust the audio session strategy for the AudioNavigator by @mickael-menu in #357
• Fix Copy and Share editing actions by @mickael-menu in #364
• Fix 367: Fix initial location when in landscape landscape by @chrfalch in #368
• Fix TTS issue by @mickael-menu in #369
• Add a new form-based bug report issue template by @mickael-menu in #374
• Update file headers by @mickael-menu in #378
• Initial pass at Locator.Locations.time by @domkm in #382
• Preferences API for AudioNavigator by @mickael-menu in #389
• Compare loggable SeverityLevel by its numeric (not string) value by @ettore in #391
• Switch to pnpm by @mickael-menu in #392
• Turn off spinner if spread doesn't begin loading by @ettore in #397
• Sniff audio clips by @mickael-menu in #403
• Use ReadiumGCDWebServer* symbols by @ettore in #404
• Bubble up errors while loading Resources by @ettore in #400
• Fix ReadiumGCDWebServer integration for CocoaPods and Carthage by @mickael-menu in #406
• Handle authentication challenges with DefaultHTTPClient by @mickael-menu in #409
• 2.7.0 by @mickael-menu in #410

New Contributors

• @domkm made their first contribution in #382
• @ettore made their first contribution in #391

Full Changelog: 2.6.1...2.7.0

2.6.1

Take a look at the migration guide

Added

Navigator

• You can now customize the playback refresh rate of _AudiobookNavigator in its configuration.
• The EPUB navigator automatically moves to the next resource when VoiceOver reaches the end of the current one.

Changed

Navigator

• You should not subclass PDFNavigatorViewController anymore. If you need to override setupPDFView, you can do so by implementing the PDFNavigatorDelegate protocol.

Fixed

Shared

• Zipped Audio Book archives are now detected even if they contain bitmap entries.

Navigator

• #344 EPUB: Fixed lost position when rotating quickly the screen several times.
• #350 Restore the ability to subclass the PDFNavigatorViewController.
• Fixed activating the scroll mode when VoiceOver is enabled in the EPUB navigator.

2.6.0

Take a look at the migration guide

• Support for Xcode 15.

Added

Navigator

• The PublicationSpeechSynthesizer (TTS) now supports background playback by default.
  • You will need to enable the Audio Background Mode in your app's build info.
• Support for non-linear EPUB resources with an opt-in in reading apps (contributed by @chrfalch in #332 and #331).
  1. Override loading non-linear resources with VisualNavigatorDelegate.navigator(_:shouldNavigateToLink:).
  2. Present a new EPUBNavigatorViewController by providing a custom readingOrder with only this resource to the constructor.

Fixed

Navigator

• Improved performance when adding hundreds of HTML decorations at once.
• Fixed broadcasting the PublicationSpeechSynthesizer with AirPlay when the screen is locked.

Changed

Navigator

• AudioSession and NowPlayingInfo are now stable!
• You need to provide the configuration of the Audio Session to the constructor of PublicationSpeechSynthesizer, instead of AVTTSEngine.

2.5.1

Take a look at the migration guide

• The Readium toolkit now requires iOS 11.0+.

Added

Navigator

• The auto spread setting is now available for fixed-layout EPUBs. It will display two pages in landscape and a single one in portrait.

Streamer

• The EPUB content iterator now returns audio and video elements and fill in the progression and totalProgression locator properties.

Changed

Navigator

• EPUBNavigatorViewController.firstVisibleElementLocator() now returns the first block element that is visible on the screen, even if it starts on previous pages.
  • This is used to make sure the user will not miss any context when restoring a TTS session in the middle of a resource.

Fixed

Navigator

• Fixed the PDF auto spread setting and scaling pages when rotating the screen.
• Fixed navigating to the first chapter of an audiobook with a single resource (contributed by @grighakobian).
• Prevent auto-playing videos in EPUB publications.
• Fixed various memory leaks and data races.
• The WKWebView is now inspectable again with Safari starting from iOS 16.4.
• Fixed crash in the PublicationSpeechSynthesizer when closing the navigator without stopping it first.
• Fixed pausing the PublicationSpeechSynthesizer right before starting the utterance.
• Fixed the audio session kept opened while the app is in the background and paused.
• Fixed the Attribute dir redefined error when the EPUB resource already has a dir attribute.
• #309 Fixed restoring the EPUB location when the application was killed in the background (contributed by @triin-ko).

Streamer

• Fix issue with the TTS starting from the beginning of the chapter instead of the current position.

2.5.0

Take a look at the migration guide

Added

Streamer

• Positions computation, TTS and search is now enabled for Readium Web Publications conforming to the EPUB profile.

Navigator

• New VisualNavigatorDelegate APIs to handle keyboard events (contributed by @lukeslu).
  • This can be used to turn pages with the arrow keys, for example.
• Support for custom fonts with the EPUB navigator.
• A brand new user preferences API for configuring the EPUB and PDF Navigators. This new API is easier and safer to use. To learn how to integrate it in your app, please refer to the user guide and migration guide.
  • New EPUB user preferences:
    • fontWeight - Base text font weight.
    • textNormalization - Normalize font style, weight and variants, which improves accessibility.
    • imageFilter - Filter applied to images in dark theme (darken, invert colors)
    • language - Language of the publication content.
    • readingProgression - Direction of the reading progression across resources, e.g. RTL.
    • typeScale - Scale applied to all element font sizes.
    • paragraphIndent - Text indentation for paragraphs.
    • paragraphSpacing - Vertical margins for paragraphs.
    • hyphens - Enable hyphenation.
    • ligatures - Enable ligatures in Arabic.
  • New PDF user preferences:
    • backgroundColor - Background color behind the document pages.
    • offsetFirstPage - Indicate if the first page should be displayed in its own spread.
    • pageSpacing - Spacing between pages in points.
    • readingProgression - Direction of the reading progression across resources, e.g. RTL.
    • scrollAxis - Scrolling direction when scroll is enabled.
    • scroll - Indicate if pages should be handled using scrolling instead of pagination.
    • spread - Enable dual-page mode.
    • visibleScrollbar - Indicate whether the scrollbar should be visible while scrolling.
• The new DirectionalNavigationAdapter component helps you to turn pages with the arrows and space keyboard keys or taps on the edge of the screen.

Deprecated

Streamer

• PublicationServer is deprecated. See the the migration guide to migrate the HTTP server.

Navigator

• The EPUB UserSettings component is deprecated and replaced by the new Preferences API. Take a look at the user guide and migration guide.

Changed

Navigator

• The define editing action replaces lookup on iOS 16+. When enabled, it will show both the "Look Up" and "Search Web" menu items.
• Prevent navigation in the EPUB while it is being loaded.

Fixed

Navigator

• Fixed a race condition issue with the AVTTSEngine, when pausing utterances.
• Fixed crash with PublicationSpeechSynthesizer, when the currently played word cannot be resolved.
• Fixed EPUB tap event sent twice when using a mouse (e.g. on Apple Silicon or with a mouse on an iPad).