Skip to content

v0.1.0

Pre-release
Pre-release

Choose a tag to compare

@ahparhizgar ahparhizgar released this 01 Jan 10:43

Release v0.1.0 — Initial release

Highlights

Typed error hierarchy: ApiCallError base plus InvalidDataError, NetworkError, HttpError with ServerError and ClientError (including BadRequest, Unauthorized, Forbidden, NotFound, RateLimitReached, OtherClientError).

  • Ktor plugin: ApiCallErrorPlugin that converts HTTP 4xx/5xx, network failures, and serialization issues into the typed errors.
  • Payload extraction: plugin supports an extractPayload hook to parse structured server error payloads (optional; uses installed content negotiation).
  • Data validation helpers: small utilities to produce InvalidDataError for parsing/validation failures.
  • Manual usage: error classes are usable without Ktor for manual error construction and handling.

Setup & distribution

Published for use via JitPack; add JitPack to settings.gradle.kts and depend on the artifacts in build.gradle.kts.

  • Artifacts in this release: core library and Ktor plugin packages (see README for coordinates).
    Usage notes - Recommended: install ApiCallErrorPlugin into Ktor HttpClient for automatic mapping.
  • Errors can be caught as ApiCallError and inspected by concrete subtype for specific handling.
    Requirements - Kotlin Multiplatform (common code) support.
  • For the Ktor plugin: Ktor Client 3.0.0 or higher.
  • Maven Central publishing not available in this release; JitPack is the only distribution.
  • Initial public release — API may evolve in minor follow-ups.

Contributing & License

Issues, contributions, and feedback welcome via the repository. See the repo for contribution guidelines and license details.