Skip to content

Releases: readium/swift-toolkit

3.4.0

03 Sep 15:04
@mickael-menu mickael-menu
3.4.0
806ece1
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
3.4.0 Latest
Latest

Warning

Minor releases (a.B.c) of the Readium toolkit may now include minor breaking changes, such as dependency upgrades or small API modifications. Major version numbers are reserved for significant architectural changes.

Take a look at the migration guide

Changelog

Added

Navigator

  • You can now access the viewport property of an EPUBNavigatorViewController to obtain information about the visible portion of the publication, including the visible positions and reading order indices.

Deprecated

Shared

Changed

Streamer

  • EPUB series added with Calibre now take precedence over the native EPUB ones in the belongsToSeries RWPM property.

Fixed

Streamer

  • #639 Optimized the opening of really large LCP protected publications.

Navigator

  • #70 Fixed restoring the reading progression with RTL EPUB.
  • EPUB vertical text in scrolling mode:
    • #556 Fixed reporting and restoring the reading progression.
    • Added support for decorations (highlights).
  • #635 Fixed overlapping FXL pages in landscape orientation.

Commits

New Contributors

  • @TechWilk made their first contribution in #615
  • @hongorzulnemo made their first contribution in #642

Full Changelog: 3.3.0...3.4.0

Contributors

TechWilk, grighakobian, and 2 other contributors
Assets 2
Loading

3.3.0

11 Jun 10:12
@mickael-menu mickael-menu
3.3.0
4ae36cf
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
3.3.0

Warning

Minor releases (a.B.c) of the Readium toolkit may now include minor breaking changes, such as dependency upgrades or small API modifications. Major version numbers are reserved for significant architectural changes.

Take a look at the migration guide

Changelog

Added

Shared

  • Implementation of the W3C Accessibility Metadata Display Guide specification to facilitate displaying accessibility metadata to users. See the dedicated user guide.
  • Support for starting from a progression in the HTML content iterator.
  • New link rels in the readingOrder and EPUB landmarks to mark:
    • cover: the title page
    • contents: the table of contents
    • start: the first actual chapter

Navigator

  • A new InputObserving API has been added to enable more flexible gesture recognition and support for mouse pointers. See the dedicated user guide.

Streamer

  • The EPUB 2 <guide> element is now parsed into the RWPM landmarks subcollection when no EPUB 3 landmarks navigation document is declared.

LCP

Fixed

Navigator

  • Fixed several issues with the EPUB navigator cursor and pointer events.
    • Fixed the cursor shape on iPadOS when using a physical trackpad or mouse.
    • Fixed multiple tap events broadcasted while running on macOS.
  • #449 Fixed misaligned EPUB navigator when it does not span the full screen width.

Commits

New Contributors

  • @qnga made their first contribution in #577

Full Changelog: 3.2.0...3.3.0

Contributors

qnga and mickael-menu
Loading

3.2.0

24 Mar 13:38
@mickael-menu mickael-menu
3.2.0
5cd863e

Choose a tag to compare

View all tags
3.2.0

Take a look at the migration guide

Changelog

Added

Shared

LCP

Changed

Shared

  • The absoluteURL and relativeURL extensions on URLConvertible were removed as they conflict with the native URL.absoluteURL.
    • If you were using them, you can for example still use anyURL.absoluteURL instead.
  • go-toolkit#92 The accessibility feature printPageNumbers is deprecated in favor of pageNavigation.

Streamer

  • A self link is not required anymore when parsing a RWPM.

Fixed

Navigator

  • Fixed going to a link containing a fragment in the PDF navigator, for example from the table of contents.

Commits

Full Changelog: 3.1.0...3.2.0

Contributors

mickael-menu
Loading

3.1.0

31 Jan 16:49
@mickael-menu mickael-menu
3.1.0
8219531

Choose a tag to compare

View all tags
3.1.0

Take a look at the migration guide

Changelog

Added

Shared

  • Support for streaming ZIP packages over HTTP. This lets you open a remote EPUB, audiobook, or any other ZIP-based publication without needing to download it first.

Deprecated

  • The close() and Closeable APIs are now deprecated. Resources are automatically released upon deinit, which aligns better with Swift.

Fixed

LCP

  • Fixed a regression that caused some LCP passphrases to no longer match the protected publication.

Navigator

  • Fixed race condition when calling submitPreferences() before the EPUB navigator is fully initialized.

Commits

Full Changelog: 3.0.0...3.1.0

Contributors

mickael-menu
Loading

3.0.0

14 Jan 15:42
@mickael-menu mickael-menu
3.0.0
6ba50b6
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
3.0.0

Take a look at the migration guide

Changelog

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

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

Read more

Contributors

domkm, FuzzzzyBoy, and 3 other contributors
Loading
0 Join discussion

3.0.0-beta.2

14 Jan 13:37
@mickael-menu mickael-menu
3.0.0-beta.2
2dc5805
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
3.0.0-beta.2 Pre-release
Pre-release

Take a look at the migration guide

Changelog

Added

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).

Changed

Shared

  • 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:).

Fixed

Shared

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

Navigator

  • #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

New Contributors

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

Contributors

alecdhansen and mickael-menu
Loading

3.0.0-beta.1

19 Nov 13:05
@mickael-menu mickael-menu
3.0.0-beta.1
2ace111
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
3.0.0-beta.1 Pre-release
Pre-release

Take a look at the migration guide

Changelog

Added

Shared

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

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.

Fixed

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

Navigator

  • #502 Fixed accessibility editing actions on iOS 18.

Commits

New Contributors

Full Changelog: 3.0.0-alpha.3...3.0.0-beta.1

Contributors

FuzzzzyBoy and mickael-menu
Loading

2.7.4

18 Nov 16:48
@mickael-menu mickael-menu
2.7.4
36f4151
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
2.7.4

Take a look at the migration guide

Changelog

Fixed

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

Navigator

  • #502 Fixed accessibility editing actions on iOS 18.

Commits

Full Changelog: 2.7.3...2.7.4

Contributors

mickael-menu
Loading

3.0.0-alpha.3

19 Oct 13:53
@mickael-menu mickael-menu
3.0.0-alpha.3
ee6afa8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
3.0.0-alpha.3 Pre-release
Pre-release

Take a look at the migration guide

Changelog

Fixed

Navigator

  • #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.

What's Changed

New Contributors

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

Contributors

vitaliynester and mickael-menu
Loading

2.7.3

17 Sep 14:57
@mickael-menu mickael-menu
2.7.3
cca64ec
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
2.7.3

Take a look at the migration guide

Changelog

  • #483 Fix build on Xcode 16.

What's Changed

Full Changelog: 2.7.2...2.7.3

Contributors

mickael-menu
Loading