Repository navigation
Action required before upgrading
Your project must compile against Android API 37 or later. The published AAR
declares minCompileSdk=37 in its metadata. Gradle enforces this during the AAR
metadata check (checkDebugAarMetadata), so a build on compileSdk 36 or lower
fails with an error stating that the dependency requires compiling against
version 37 or later of the Android APIs.
Set compileSdk = 37 in your module's build.gradle.
minSdk is unchanged at 21 — the range of devices your app supports is not
affected. This is a build-time requirement only.
Breaking changes
Custom apiBaseUrl must be HTTPS. initialize() now rejects a non-HTTPS
base URL with IllegalArgumentException("apiBaseUrl must be an https:// URL").
Loopback addresses (127.0.0.1, localhost, [::1]) are still accepted so
tests using MockWebServer keep working. If you pass a plain http:// host, move
it to https:// before upgrading.
HTTP requests now time out. The OkHttp client previously had no timeouts, so
a stalled connection could hang indefinitely. It now uses connect 30s, read 120s,
write 120s. Calls that relied on waiting longer than these limits will now fail
with a timeout instead of blocking.
Security
- The API key is redacted from debug log output.
Log.dpreviously printed the
full request URL includingapi_key=...; it now printsapi_key=REDACTED. - Custom API hosts are restricted to HTTPS (see above), preventing credentials
from being sent over plaintext to a misconfigured host.
Dependencies
Shipped with the SDK (transitive for consumers):
- okhttp 5.4.0 → 5.5.0
- androidx.appcompat 1.7.1 → 1.8.0
Build-time only, not propagated to consumers:
- compileSdk 36 → 37, build-tools 37.0.0
- Gradle wrapper 9.6.1 → 9.7.1
- GitHub Actions workflow updates
Why this is 2.2.0 and not 2.1.5
The compileSdk requirement and the HTTPS/timeout changes each alter behaviour for
existing users, which a patch release should not do.
What's Changed
- Harden SDK logging, HTTP defaults, and CI supply chain by @franciscbalint in #50
- Bump the github group across 1 directory with 2 updates by @dependabot[bot] in #53
- Bump the android group across 1 directory with 4 updates by @dependabot[bot] in #52
New Contributors
- @franciscbalint made their first contribution in #50
Full Changelog: v2.1.4...v2.2.0