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