3.0.0-alpha.2

[mickael-menu]

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

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

---

This discussion was created from the release 3.0.0-alpha.2.