feat: add zio-json support

.github/workflows/ci.yml

@@ -53,7 +53,7 @@ jobs:
       - run: sbt '++ ${{ matrix.scala }}' test docs/mdoc mimaReportBinaryIssues
 
       - name: Compress target directories
-        run: tar cf targets.tar oauth2-jsoniter/jvm/target oauth2/js/target oauth2-cache/js/target oauth2-cache-ce2/target oauth2-cache-zio/target oauth2-jsoniter/js/target target oauth2-cache-scalacache/target mdoc/target oauth2-circe/jvm/target oauth2-cache-cats/target oauth2-cache-future/jvm/target oauth2-circe/js/target oauth2-cache/jvm/target oauth2-cache-future/js/target oauth2/jvm/target project/target
+        run: tar cf targets.tar oauth2-jsoniter/jvm/target oauth2/js/target oauth2-cache/js/target oauth2-cache-ce2/target oauth2-cache-zio/target oauth2-jsoniter/js/target target oauth2-cache-scalacache/target mdoc/target oauth2-circe/jvm/target oauth2-cache-cats/target oauth2-zio-json/js/target oauth2-cache-future/jvm/target oauth2-circe/js/target oauth2-cache/jvm/target oauth2-cache-future/js/target oauth2-zio-json/jvm/target oauth2/jvm/target project/target
 
       - name: Upload target directories
         uses: actions/upload-artifact@v4

build.sbt

@@ -1,5 +1,7 @@
 import sbtghactions.UseRef
 
+Global / onChangedBuildSource := ReloadOnSourceChanges
+
 inThisBuild(
   List(
     organization := "org.polyvariant",
@@ -51,6 +53,7 @@ val Versions = new {
   val catsEffect2 = "2.5.5"
   val circe = "0.14.9"
   val jsoniter = "2.30.7"
+  val zioJson = "0.7.45"
   val monix = "3.4.1"
   val scalaTest = "3.2.19"
   val sttp = "4.0.3"
@@ -130,6 +133,27 @@ lazy val `oauth2-jsoniter` = crossProject(JSPlatform, JVMPlatform)
   )
   .dependsOn(oauth2 % "compile->compile;test->test")
 
+lazy val `oauth2-zio-json` = crossProject(JSPlatform, JVMPlatform)
+  .withoutSuffixFor(JVMPlatform)
+  .in(file("oauth2-zio-json"))
+  .settings(
+    name := "sttp-oauth2-zio-json",
+    libraryDependencies ++= Seq(
+      "dev.zio" %%% "zio-json" % Versions.zioJson
+    ),
+    // zio-json-macros only available for Scala 2.x (provides @jsonField for Scala 2)
+    // For Scala 3, @jsonField is in zio-json core
+    libraryDependencies ++= (
+      if (scalaVersion.value.startsWith("3")) Seq.empty
+      else Seq("dev.zio" %%% "zio-json-macros" % Versions.zioJson)
+    ),
+    mimaSettings,
+    compilerPlugins,
+    // zio-json 0.7.45 pulls in scala-library 2.13.17, allow upgrade for Scala 2.13
+    allowUnsafeScalaLibUpgrade := true
+  )
+  .dependsOn(oauth2 % "compile->compile;test->test")
+
 lazy val docs = project
   .in(file("mdoc")) // important: it must not be docs/
   .settings(
@@ -259,5 +283,7 @@ val root = project
     `oauth2-circe`.jvm,
     `oauth2-circe`.js,
     `oauth2-jsoniter`.jvm,
-    `oauth2-jsoniter`.js
+    `oauth2-jsoniter`.js,
+    `oauth2-zio-json`.jvm,
+    `oauth2-zio-json`.js
   )

oauth2-zio-json/shared/src/main/scala/org/polyvariant/sttp/oauth2/json/ziojson/ZioJsonDecoders.scala

@@ -0,0 +1,301 @@
+package org.polyvariant.sttp.oauth2.json.ziojson
+
+import org.polyvariant.sttp.oauth2.ClientCredentialsToken.AccessTokenResponse
+import org.polyvariant.sttp.oauth2.ExtendedOAuth2TokenResponse
+import org.polyvariant.sttp.oauth2.Introspection.Audience
+import org.polyvariant.sttp.oauth2.Introspection.SeqAudience
+import org.polyvariant.sttp.oauth2.Introspection.StringAudience
+import org.polyvariant.sttp.oauth2.Introspection.TokenIntrospectionResponse
+import org.polyvariant.sttp.oauth2.OAuth2TokenResponse
+import org.polyvariant.sttp.oauth2.RefreshTokenResponse
+import org.polyvariant.sttp.oauth2.Secret
+import org.polyvariant.sttp.oauth2.TokenUserDetails
+import org.polyvariant.sttp.oauth2.UserInfo
+import org.polyvariant.sttp.oauth2.common.Error.OAuth2Error
+import org.polyvariant.sttp.oauth2.common.Scope
+import org.polyvariant.sttp.oauth2.json.{JsonDecoder => OAuth2JsonDecoder}
+import zio.json._
+import zio.json.jsonMemberNames
+import zio.json.SnakeCase
+
+import java.time.Instant
+import scala.concurrent.duration.DurationLong
+import scala.concurrent.duration.FiniteDuration
+
+trait ZioJsonDecoders {
+  import ZioJsonDecoders._
+
+  implicit def jsonDecoder[A](
+    implicit decoder: JsonDecoder[A]
+  ): OAuth2JsonDecoder[A] =
+    (data: String) => decoder.decodeJson(data).left.map(msg => OAuth2JsonDecoder.Error(msg))
+
+  implicit val secretStringDecoder: JsonDecoder[Secret[String]] =
+    JsonDecoder.string.map(Secret(_))
+
+  implicit val secondsDecoder: JsonDecoder[FiniteDuration] =
+    JsonDecoder.long.map(_.seconds)
+
+  implicit val instantDecoder: JsonDecoder[Instant] =
+    JsonDecoder.long.map(Instant.ofEpochSecond)
+
+  implicit val scopeDecoder: JsonDecoder[Scope] =
+    JsonDecoder.string.mapOrFail { value =>
+      Scope.from(value).left.map(identity)
+    }
+
+  implicit val optionScopeDecoder: JsonDecoder[Option[Scope]] =
+    JsonDecoder.option[String].mapOrFail {
+      case None | Some("") => Right(None)
+      case Some(value)     => Scope.from(value).map(Some(_)).left.map(identity)
+    }
+
+  implicit val tokenUserDetailsDecoder: JsonDecoder[TokenUserDetails] =
+    DeriveJsonDecoder.gen[TokenUserDetails]
+
+  implicit val userInfoDecoder: JsonDecoder[UserInfo] =
+    userInfoRawDecoder.map { raw =>
+      UserInfo(
+        raw.sub,
+        raw.name,
+        raw.givenName,
+        raw.familyName,
+        raw.jobTitle,
+        raw.domain,
+        raw.preferredUsername,
+        raw.email,
+        raw.emailVerified,
+        raw.locale,
+        raw.sites.getOrElse(Nil),
+        raw.banners.getOrElse(Nil),
+        raw.regions.getOrElse(Nil),
+        raw.fulfillmentContexts.getOrElse(Nil)
+      )
+    }
+
+  implicit val accessTokenResponseDecoder: JsonDecoder[AccessTokenResponse] =
+    accessTokenResponseRawDecoder.mapOrFail { raw =>
+      if (raw.tokenType.equalsIgnoreCase("Bearer"))
+        Right(AccessTokenResponse(raw.accessToken, raw.domain, raw.expiresIn, raw.scope))
+      else
+        Left(s"Error while decoding '.token_type': value '${raw.tokenType}' is not equal to 'Bearer'")
+    }
+
+  implicit val oAuth2ErrorDecoder: JsonDecoder[OAuth2Error] =
+    oAuth2ErrorRawDecoder.map { raw =>
+      OAuth2Error.fromErrorTypeAndDescription(raw.error, raw.errorDescription)
+    }
+
+  implicit val oAuth2TokenResponseDecoder: JsonDecoder[OAuth2TokenResponse] =
+    oAuth2TokenResponseRawDecoder.map { raw =>
+      OAuth2TokenResponse(raw.accessToken, raw.scope, raw.tokenType, raw.expiresIn, raw.refreshToken)
+    }
+
+  implicit val extendedOAuth2TokenResponseDecoder: JsonDecoder[ExtendedOAuth2TokenResponse] =
+    extendedOAuth2TokenResponseRawDecoder.map { raw =>
+      ExtendedOAuth2TokenResponse(
+        raw.accessToken,
+        raw.refreshToken,
+        raw.expiresIn,
+        raw.userName,
+        raw.domain,
+        raw.userDetails,
+        raw.roles,
+        raw.scope,
+        raw.securityLevel,
+        raw.userId,
+        raw.tokenType
+      )
+    }
+
+  implicit val audienceDecoder: JsonDecoder[Audience] =
+    JsonDecoder
+      .string
+      .map(StringAudience(_))
+      .orElse(
+        JsonDecoder.list[String].map(seq => SeqAudience(seq))
+      )
+
+  implicit val tokenIntrospectionResponseDecoder: JsonDecoder[TokenIntrospectionResponse] =
+    tokenIntrospectionResponseRawDecoder.map { raw =>
+      TokenIntrospectionResponse(
+        raw.active,
+        raw.clientId,
+        raw.domain,
+        raw.exp,
+        raw.iat,
+        raw.nbf,
+        raw.authorities,
+        raw.scope,
+        raw.tokenType,
+        raw.sub,
+        raw.iss,
+        raw.jti,
+        raw.aud
+      )
+    }
+
+  implicit val refreshTokenResponseDecoder: JsonDecoder[RefreshTokenResponse] =
+    refreshTokenResponseRawDecoder.map { raw =>
+      RefreshTokenResponse(
+        raw.accessToken,
+        raw.refreshToken,
+        raw.expiresIn,
+        raw.userName,
+        raw.domain,
+        raw.userDetails,
+        raw.roles,
+        raw.scope,
+        raw.securityLevel,
+        raw.userId,
+        raw.tokenType
+      )
+    }
+
+}
+
+object ZioJsonDecoders {
+
+  // Base decoders needed for derivation
+  private[ziojson] implicit val secretStringDecoder: JsonDecoder[Secret[String]] =
+    JsonDecoder.string.map(Secret(_))
+
+  private[ziojson] implicit val secondsDecoder: JsonDecoder[FiniteDuration] =
+    JsonDecoder.long.map(_.seconds)
+
+  private[ziojson] implicit val instantDecoder: JsonDecoder[Instant] =
+    JsonDecoder.long.map(Instant.ofEpochSecond)
+
+  private[ziojson] implicit val scopeDecoder: JsonDecoder[Scope] =
+    JsonDecoder.string.mapOrFail { value =>
+      Scope.from(value).left.map(identity)
+    }
+
+  private[ziojson] implicit val optionScopeDecoder: JsonDecoder[Option[Scope]] =
+    JsonDecoder.option[String].mapOrFail {
+      case None | Some("") => Right(None)
+      case Some(value)     => Scope.from(value).map(Some(_)).left.map(identity)
+    }
+
+  private[ziojson] implicit val tokenUserDetailsDecoder: JsonDecoder[TokenUserDetails] =
+    DeriveJsonDecoder.gen[TokenUserDetails]
+
+  private[ziojson] implicit val audienceDecoder: JsonDecoder[Audience] =
+    JsonDecoder
+      .string
+      .map(StringAudience(_))
+      .orElse(
+        JsonDecoder.list[String].map(seq => SeqAudience(seq))
+      )
+
+  @jsonMemberNames(SnakeCase)
+  private[ziojson] final case class UserInfoRaw(
+    sub: Option[String],
+    name: Option[String],
+    givenName: Option[String],
+    familyName: Option[String],
+    jobTitle: Option[String],
+    domain: Option[String],
+    preferredUsername: Option[String],
+    email: Option[String],
+    emailVerified: Option[Boolean],
+    locale: Option[String],
+    sites: Option[List[String]],
+    banners: Option[List[String]],
+    regions: Option[List[String]],
+    fulfillmentContexts: Option[List[String]]
+  )
+
+  private[ziojson] val userInfoRawDecoder: JsonDecoder[UserInfoRaw] =
+    DeriveJsonDecoder.gen[UserInfoRaw]
+
+  @jsonMemberNames(SnakeCase)
+  private[ziojson] final case class AccessTokenResponseRaw(
+    accessToken: Secret[String],
+    domain: Option[String],
+    expiresIn: FiniteDuration,
+    scope: Option[Scope],
+    tokenType: String
+  )
+
+  private[ziojson] val accessTokenResponseRawDecoder: JsonDecoder[AccessTokenResponseRaw] =
+    DeriveJsonDecoder.gen[AccessTokenResponseRaw]
+
+  @jsonMemberNames(SnakeCase)
+  private[ziojson] final case class OAuth2ErrorRaw(
+    error: String,
+    errorDescription: Option[String]
+  )
+
+  private[ziojson] val oAuth2ErrorRawDecoder: JsonDecoder[OAuth2ErrorRaw] =
+    DeriveJsonDecoder.gen[OAuth2ErrorRaw]
+
+  @jsonMemberNames(SnakeCase)
+  private[ziojson] final case class OAuth2TokenResponseRaw(
+    accessToken: Secret[String],
+    scope: String,
+    tokenType: String,
+    expiresIn: Option[FiniteDuration],
+    refreshToken: Option[String]
+  )
+
+  private[ziojson] val oAuth2TokenResponseRawDecoder: JsonDecoder[OAuth2TokenResponseRaw] =
+    DeriveJsonDecoder.gen[OAuth2TokenResponseRaw]
+
+  @jsonMemberNames(SnakeCase)
+  private[ziojson] final case class ExtendedOAuth2TokenResponseRaw(
+    accessToken: Secret[String],
+    refreshToken: String,
+    expiresIn: FiniteDuration,
+    userName: String,
+    domain: String,
+    userDetails: TokenUserDetails,
+    roles: Set[String],
+    scope: String,
+    securityLevel: Long,
+    userId: String,
+    tokenType: String
+  )
+
+  private[ziojson] val extendedOAuth2TokenResponseRawDecoder: JsonDecoder[ExtendedOAuth2TokenResponseRaw] =
+    DeriveJsonDecoder.gen[ExtendedOAuth2TokenResponseRaw]
+
+  @jsonMemberNames(SnakeCase)
+  private[ziojson] final case class TokenIntrospectionResponseRaw(
+    active: Boolean,
+    clientId: Option[String],
+    domain: Option[String],
+    exp: Option[Instant],
+    iat: Option[Instant],
+    nbf: Option[Instant],
+    authorities: Option[List[String]],
+    scope: Option[Scope],
+    tokenType: Option[String],
+    sub: Option[String],
+    iss: Option[String],
+    jti: Option[String],
+    aud: Option[Audience]
+  )
+
+  private[ziojson] val tokenIntrospectionResponseRawDecoder: JsonDecoder[TokenIntrospectionResponseRaw] =
+    DeriveJsonDecoder.gen[TokenIntrospectionResponseRaw]
+
+  @jsonMemberNames(SnakeCase)
+  private[ziojson] final case class RefreshTokenResponseRaw(
+    accessToken: Secret[String],
+    refreshToken: Option[String],
+    expiresIn: FiniteDuration,
+    userName: String,
+    domain: String,
+    userDetails: TokenUserDetails,
+    roles: Set[String],
+    scope: String,
+    securityLevel: Long,
+    userId: String,
+    tokenType: String
+  )
+
+  private[ziojson] val refreshTokenResponseRawDecoder: JsonDecoder[RefreshTokenResponseRaw] =
+    DeriveJsonDecoder.gen[RefreshTokenResponseRaw]
+
+}

oauth2-zio-json/shared/src/main/scala/org/polyvariant/sttp/oauth2/json/ziojson/instances.scala

@@ -0,0 +1,3 @@
+package org.polyvariant.sttp.oauth2.json.ziojson
+
+object instances extends ZioJsonDecoders

oauth2-zio-json/shared/src/test/scala/org/polyvariant/sttp/oauth2/json/ziojson/ZioJsonSpec.scala

@@ -0,0 +1,27 @@
+package org.polyvariant.sttp.oauth2.json.ziojson
+
+import org.polyvariant.sttp.oauth2.json.JsonSpec
+import org.polyvariant.sttp.oauth2.json.ziojson.instances._
+import org.polyvariant.sttp.oauth2.json.JsonDecoder
+import org.polyvariant.sttp.oauth2.Introspection.TokenIntrospectionResponse
+import org.polyvariant.sttp.oauth2.common._
+import org.polyvariant.sttp.oauth2.ClientCredentialsToken
+import org.polyvariant.sttp.oauth2.ExtendedOAuth2TokenResponse
+import org.polyvariant.sttp.oauth2.RefreshTokenResponse
+import org.polyvariant.sttp.oauth2.UserInfo
+
+class ZioJsonSpec extends JsonSpec {
+
+  protected implicit def tokenIntrospectionResponseJsonDecoder: JsonDecoder[TokenIntrospectionResponse] = jsonDecoder
+
+  protected implicit def oAuth2ErrorJsonDecoder: JsonDecoder[Error.OAuth2Error] = jsonDecoder
+
+  protected implicit def extendedOAuth2TokenResponseJsonDecoder: JsonDecoder[ExtendedOAuth2TokenResponse] = jsonDecoder
+
+  protected implicit def refreshTokenResponseJsonDecoder: JsonDecoder[RefreshTokenResponse] = jsonDecoder
+
+  protected implicit def userInfoJsonDecoder: JsonDecoder[UserInfo] = jsonDecoder
+
+  protected implicit def accessTokenResponseJsonDecoder: JsonDecoder[ClientCredentialsToken.AccessTokenResponse] = jsonDecoder
+
+}