3.0.0

[mickael-menu]

Take a look at the migration guide

Changelog

• The Readium Swift toolkit now requires a minimum of iOS 13.4.
• All the libraries are now available on a dedicated Readium CocoaPods Specs repository. Take a look at the migration guide to migrate.

Added

Shared

• TableOfContentsService can now be used to customize the computation of publication.tableOfContents().

Streamer

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

Navigator

• The EPUBNavigatorViewController.Configuration.disablePageTurnsWhileScrolling property disables horizontal swipes for navigating to previous or next resources when scroll mode is enabled. When set to true, you must implement your own mechanism to move to the next resource (contributed by @alecdhansen).

LCP

• The table of contents of an LCP-protected PDF is now extracted directly from the PDF if the tableOfContents property in manifest.json is empty.

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.
• Plenty of completion-based APIs were changed to use async functions instead.

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.
• 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.
• The default ZIPArchiveOpener is now using ZIPFoundation instead of Minizip, with improved performances when reading ranges of stored ZIP entries.
• Improvements in the HTTP client:
  • The consume closure of HTTPClient.stream() can now return an error to abort the HTTP request.
  • HTTPError has been refactored for improved type safety and a clearer separation of connection errors versus HTTP errors.
  • DefaultHTTPClient no longer automatically restarts a failed HEAD request as a GET to retrieve the response body. If you relied on this behavior, you can implement it using a custom DefaultHTTPClientDelegate.httpClient(_:recoverRequest:fromError:).

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

• #489 Fix crash related to Fuzi when compiling with Xcode 16 in release mode.

Shared

• Fixed a crash using HTTPClient.download() when the device storage is full.

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.
• #459 Fixed the stack overflow issue that occurred when running the text-to-speech on an EPUB file with many empty resources.
• #490 Fixed issue loading fixed-layout EPUBs.
• #502 Fixed accessibility editing actions on iOS 18.
• #509 Removed the "Copy Link with Highlight" and "Writing Tools" EPUB editing actions on newer devices.

OPDS

• Fixed a data race in the OPDS 1 parser.

Commits

• Refactor HREF normalization and models by @mickael-menu in Refactor HREF normalization and models #358
• Validate Link's href when creating a URL by @mickael-menu in Validate Link's href when creating a URL #379
• Fix audiobook regression by @mickael-menu in Fix audiobook regression #380
• Prevent crash when reporting the currently spoken word by @mickael-menu in Prevent crash when reporting the currently spoken word #381
• Validate Link HREFs only when they are not templated by @mickael-menu in Validate Link HREFs only when they are not templated #387
• Fix audiobook regression by @mickael-menu in Fix audiobook regression #393
• Drop R2 prefix by @mickael-menu in Drop R2 prefix #412
• Don't require a self link to enable HTTP requests in a RWPM by @mickael-menu in Don't require a self link to enable HTTP requests in a RWPM #415
• Documentation by @mickael-menu in Documentation #384
• 3.0.0-alpha.1 by @mickael-menu in 3.0.0-alpha.1 #420
• 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
• 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
• Remove Resources declaration from ReadiumShared by @mickael-menu in Remove Resources declaration from ReadiumShared #481
• Fix stack overflow when searching in a book with a large TOC by @vitaliynester in Fix stack overflow when searching in a book with a large TOC #473
• Fix stack overflow with TTS by @mickael-menu in Fix stack overflow with TTS #482
• Fix issue loading fixed-layout EPUBs by @mickael-menu in Fix issue loading fixed-layout EPUBs #493
• 3.0.0-alpha.3 by @mickael-menu in 3.0.0-alpha.3 #496
• About screen sui by @FuzzzzyBoy in About screen sui #492
• Swift UI refactor opds catalog selector by @FuzzzzyBoy in Swift UI refactor opds catalog selector #497
• Various v3 fixes by @mickael-menu in Various v3 fixes #499
• Extract the table of contents from an LCP-protected PDF by @mickael-menu in Extract the table of contents from an LCP-protected PDF #480
• SUI refactoring facets screen by @FuzzzzyBoy in SUI refactoring facets screen #501
• 3.0.0-beta.1 by @mickael-menu in 3.0.0-beta.1 #507
• Main actor conformance for the navigator delegates by @mickael-menu in Main actor conformance for the navigator delegates #511
• Fix PublicationService.get() by @mickael-menu in Fix PublicationService.get() #513
• Remove unused Minizip from ReadiumStreamer by @mickael-menu in Remove unused Minizip from ReadiumStreamer #517
• Migrate to ZIPFoundation by @mickael-menu in Migrate to ZIPFoundation #518
• Fix various crashes and memory leaks by @mickael-menu in Fix various crashes and memory leaks #520
• Update file headers by @mickael-menu in Update file headers #525
• Fix EPUB deobfuscation of ranges by @mickael-menu in Fix EPUB deobfuscation of ranges #526
• Optimize two-pages spread computation by @mickael-menu in Optimize two-pages spread computation #527
• Don't crash the app if the LCP database cannot be opened by @mickael-menu in Don't crash the app if the LCP database cannot be opened #528
• Fix data race in OPDS1Parser by @mickael-menu in Fix data race in OPDS1Parser #529
• Improve the HTTP client by @mickael-menu in Improve the HTTP client #530
• feat: add option to disable horizontal swiping when settings.scroll is true by @alecdhansen in feat: add option to disable horizontal swiping when settings.scroll is true #531
• Remove the "Copy Link with Highlight" and "Writing Tools" EPUB editing actions by @mickael-menu in Remove the "Copy Link with Highlight" and "Writing Tools" EPUB editing actions #532
• Fix concurrency warnings by @mickael-menu in Fix concurrency warnings #533
• 3.0.0-beta.2 by @mickael-menu in 3.0.0-beta.2 #534
• 3.0.0 by @mickael-menu in 3.0.0 #535

New Contributors

• @vitaliynester made their first contribution in Fix stack overflow when searching in a book with a large TOC #473
• @FuzzzzyBoy made their first contribution in About screen sui #492
• @alecdhansen made their first contribution in feat: add option to disable horizontal swiping when settings.scroll is true #531

Full Changelog: 2.7.4...3.0.0

---

This discussion was created from the release 3.0.0.