Release 4.0.14

Author: adamw

README.md

@@ -15,7 +15,7 @@ The library is available for Scala 2.12, 2.13 and 3. Supported platforms are the
 Here's a quick example of sttp client in action, runnable using [scala-cli](https://scala-cli.virtuslab.org):
 
 ```scala
-//> using dep com.softwaremill.sttp.client4::core:4.0.13
+//> using dep com.softwaremill.sttp.client4::core:4.0.14
 
 import sttp.client4.quick.*
 
@@ -34,7 +34,7 @@ Additionally, sttp client seamlessly integrates with popular libraries for JSON
 Some more features: URI interpolation, a self-managed backend, and type-safe HTTP error/success representation, are demonstrated by the below example:
 
 ```scala
-//> using dep com.softwaremill.sttp.client4::core:4.0.13
+//> using dep com.softwaremill.sttp.client4::core:4.0.14
 
 import sttp.client4.*
 
@@ -69,15 +69,15 @@ sttp (v2) documentation is available at [sttp.softwaremill.com/en/v2](https://st
 
 sttp (v1) documentation is available at [sttp.softwaremill.com/en/v1](https://sttp.softwaremill.com/en/v1).
 
-scaladoc is available at [https://www.javadoc.io](https://www.javadoc.io/doc/com.softwaremill.sttp.client4/core_3/4.0.13)
+scaladoc is available at [https://www.javadoc.io](https://www.javadoc.io/doc/com.softwaremill.sttp.client4/core_3/4.0.14)
 
 ## Quickstart with scala-cli
 
 Add the following directive to the top of your scala file to add the core sttp dependency:
 If you are using [scala-cli](https://scala-cli.virtuslab.org), you can quickly start experimenting with sttp by copy-pasting the following:
 
 ```
-//> using dep "com.softwaremill.sttp.client4::core:4.0.13"
+//> using dep "com.softwaremill.sttp.client4::core:4.0.14"
 import sttp.client4.quick.*
 quickRequest.get(uri"http://httpbin.org/ip").send()
 ```
@@ -89,7 +89,7 @@ The `quick` package import brings in the sttp API and a pre-configured, global s
 Similarly, using [Ammonite](http://ammonite.io):
 
 ```scala
-import $ivy.`com.softwaremill.sttp.client4::core:4.0.13`
+import $ivy.`com.softwaremill.sttp.client4::core:4.0.14`
 import sttp.client4.quick.*
 quickRequest.get(uri"http://httpbin.org/ip").send()
 ```
@@ -99,7 +99,7 @@ quickRequest.get(uri"http://httpbin.org/ip").send()
 Add the following dependency:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "core" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "core" % "4.0.14"
 ```
 
 Then, import:
@@ -156,7 +156,7 @@ The documentation is typechecked using [mdoc](https://scalameta.org/mdoc/). The
 
 When generating documentation, it's best to set the version to the current one, so that the generated doc files don't include modifications with the current snapshot version. 
 
-That is, in sbt run: `set ThisBuild/version := "4.0.13"`, before running `mdoc` in `docs`.
+That is, in sbt run: `set ThisBuild/version := "4.0.14"`, before running `mdoc` in `docs`.
 
 ### Testing the Scala.JS backend
 

generated-docs/out/backends/akka.md

@@ -3,7 +3,7 @@
 This backend is based on [akka-http](http://doc.akka.io/docs/akka-http/current/scala/http/). To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %% "akka-http-backend" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "akka-http-backend" % "4.0.14"
 ```
 
 A fully **asynchronous** backend. Uses the `Future` effect to return responses. There are also [other `Future`-based backends](future.md), which don't depend on Akka. 

generated-docs/out/backends/catseffect.md

@@ -14,7 +14,7 @@ Also note that the [http4s](http4s.md) backend can also be created for a type im
 Firstly, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "cats" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "cats" % "4.0.14"
 ```
 
 Obtain a cats-effect `Resource` which creates the backend, and closes the thread pool after the resource is no longer used:
@@ -83,9 +83,9 @@ Firstly, add the following dependency to your project:
 
 ```scala
 // for cats-effect 3.x
-"com.softwaremill.sttp.client4" %% "armeria-backend-cats" % "4.0.13" 
+"com.softwaremill.sttp.client4" %% "armeria-backend-cats" % "4.0.14" 
 // or for cats-effect 2.x
-"com.softwaremill.sttp.client4" %% "armeria-backend-cats-ce2" % "4.0.13" 
+"com.softwaremill.sttp.client4" %% "armeria-backend-cats-ce2" % "4.0.14" 
 ```
 
 create client:

generated-docs/out/backends/finagle.md

@@ -3,7 +3,7 @@
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %% "finagle-backend" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "finagle-backend" % "4.0.14"
 ```
 
 Next you'll need to add an implicit value:

generated-docs/out/backends/fs2.md

@@ -12,9 +12,9 @@ Creation of the backend can be done in two basic ways:
 Firstly, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "fs2" % "4.0.13" // for cats-effect 3.x & fs2 3.x
+"com.softwaremill.sttp.client4" %% "fs2" % "4.0.14" // for cats-effect 3.x & fs2 3.x
 // or 
-"com.softwaremill.sttp.client4" %% "fs2ce2" % "4.0.13" // for cats-effect 2.x & fs2 2.x
+"com.softwaremill.sttp.client4" %% "fs2ce2" % "4.0.14" // for cats-effect 2.x & fs2 2.x
 ```
 
 Obtain a cats-effect `Resource` which creates the backend, and closes the thread pool after the resource is no longer used:
@@ -78,9 +78,9 @@ To use, add the following dependency to your project:
 
 ```scala
 // for cats-effect 3.x & fs2 3.x
-"com.softwaremill.sttp.client4" %% "armeria-backend-fs2" % "4.0.13" 
+"com.softwaremill.sttp.client4" %% "armeria-backend-fs2" % "4.0.14" 
 // or for cats-effect 2.x & fs2 2.x
-"com.softwaremill.sttp.client4" %% "armeria-backend-fs2-ce2" % "4.0.13" 
+"com.softwaremill.sttp.client4" %% "armeria-backend-fs2-ce2" % "4.0.14" 
 ```
 
 create client:
@@ -126,6 +126,11 @@ This backend is built on top of [Armeria](https://armeria.dev/docs/client-http).
 Armeria's [ClientFactory](https://armeria.dev/docs/client-factory) manages connections and protocol-specific properties.
 Please visit [the official documentation](https://armeria.dev/docs/client-factory) to learn how to configure it.
 
+## Using JavaScript
+
+The Fs2 backend is also available for the JS platform, see [the `FetchBackend` documentation](javascript/fetch.md).
+The `FetchFs2Backend` companion object contains methods to create the backend directly.
+
 ## Streaming
 
 The fs2 backends support streaming for any instance of the `cats.effect.Effect` typeclass, such as `cats.effect.IO`. If `IO` is used then the type of supported streams is `fs2.Stream[IO, Byte]`. The streams capability is represented as `sttp.client4.fs2.Fs2Streams`.

generated-docs/out/backends/future.md

@@ -21,7 +21,7 @@ Class                                 Supported stream type
 To use, you don't need any extra dependencies, `core` is enough:
 
 ```
-"com.softwaremill.sttp.client4" %% "core" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "core" % "4.0.14"
 ```
 
 You'll need the following imports:
@@ -59,7 +59,7 @@ Host header override is supported in environments running Java 12 onwards, but i
 To use, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "okhttp-backend" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "okhttp-backend" % "4.0.14"
 ```
 
 and some imports:
@@ -91,7 +91,7 @@ This backend depends on [OkHttp](http://square.github.io/okhttp/) and fully supp
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %% "armeria-backend" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "armeria-backend" % "4.0.14"
 ```
 
 add imports:

generated-docs/out/backends/http4s.md

@@ -4,9 +4,9 @@ This backend is based on [http4s](https://http4s.org) (client) and is **asynchro
 
 ```scala
 // for cats-effect 3.x & http4s 1.0.0-Mx
-"com.softwaremill.sttp.client4" %% "http4s-backend" % "4.0.13" 
+"com.softwaremill.sttp.client4" %% "http4s-backend" % "4.0.14" 
 // or for cats-effect 2.x & http4s 0.21.x
-"com.softwaremill.sttp.client4" %% "http4s-ce2-backend" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "http4s-ce2-backend" % "4.0.14"
 ```
 
 The backend can be created in a couple of ways, e.g.:

generated-docs/out/backends/javascript/fetch.md

@@ -7,7 +7,7 @@ A JavaScript backend with web socket support. Implemented using the [Fetch API](
 This is the default backend, available in the main jar for JS. To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %%% "core" % "4.0.13"
+"com.softwaremill.sttp.client4" %%% "core" % "4.0.14"
 ```
 
 And create the backend instance:
@@ -26,7 +26,7 @@ Note that `Fetch` does not pass cookies by default. If your request needs cookie
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %%% "monix" % "4.0.13"
+"com.softwaremill.sttp.client4" %%% "monix" % "4.0.14"
 ```
 
 And create the backend instance:
@@ -40,7 +40,7 @@ val backend = FetchMonixBackend()
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %%% "zio" % "4.0.13"
+"com.softwaremill.sttp.client4" %%% "zio" % "4.0.14"
 ```
 
 And create the backend instance:
@@ -55,13 +55,13 @@ Any effect implementing the cats-effect `Concurrent` typeclass can be used. To u
 your project:
 
 ```
-"com.softwaremill.sttp.client4" %%% "cats" % "4.0.13"
+"com.softwaremill.sttp.client4" %%% "cats" % "4.0.14"
 ```
 
 If you are on Cats Effect 2 (CE2) you will need to add the CE2 specific dependency instead:
 
 ```
-"com.softwaremill.sttp.client4" %%% "catsce2" % "4.0.13"
+"com.softwaremill.sttp.client4" %%% "catsce2" % "4.0.14"
 ```
 
 And create the backend instance:
@@ -70,6 +70,21 @@ And create the backend instance:
 val backend = FetchCatsBackend[IO]()
 ```
 
+## fs2-based
+
+Any effect implementing the cats-effect `Async` typeclass can be used. To use, add the following dependency to 
+your project:
+
+```
+"com.softwaremill.sttp.client4" %%% "fs2" % "4.0.14"
+```
+
+And create the backend instance:
+
+```scala
+val backend = FetchFs2Backend[IO]()
+```
+
 ## Node.js
 
 ### CommonJS module
@@ -129,7 +144,7 @@ Streaming support is provided via `FetchMonixBackend`. Note that streaming suppo
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %%% "monix" % "4.0.13"
+"com.softwaremill.sttp.client4" %%% "monix" % "4.0.14"
 ```
 
 An example of streaming a response:
@@ -161,4 +176,4 @@ The backend supports both regular and streaming [websockets](../../other/websock
 
 ## Server-sent events
 
-Received data streams can be parsed to a stream of server-sent events (SSE), when using the [Monix](../monix.md) and [ZIO](../zio.md) variants - the respective documentation pages contain appropriate SSE examples.
+Received data streams can be parsed to a stream of server-sent events (SSE), when using the [Monix](../monix.md), [ZIO](../zio.md), or [Fs2](../fs2.md) variants - the respective documentation pages contain appropriate SSE examples.

generated-docs/out/backends/monix.md

@@ -12,7 +12,7 @@ Creation of the backend can be done in two basic ways:
 Firstly, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %% "monix" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "monix" % "4.0.14"
 ```
 
 and create the backend using:
@@ -49,7 +49,7 @@ Host header override is supported in environments running Java 12 onwards, but i
 To use, add the following dependency to your project:
 
 ```scala
-"com.softwaremill.sttp.client4" %% "okhttp-backend-monix" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "okhttp-backend-monix" % "4.0.14"
 ```
 
 Create the backend using:
@@ -75,7 +75,7 @@ This backend depends on [OkHttp](http://square.github.io/okhttp/) and fully supp
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %% "armeria-backend-monix" % "4.0.13"
+"com.softwaremill.sttp.client4" %% "armeria-backend-monix" % "4.0.14"
 ```
 
 add imports:

generated-docs/out/backends/native/curl.md

@@ -5,7 +5,7 @@ A Scala Native (0.5.x) backend implemented using [Curl](https://github.com/curl/
 To use, add the following dependency to your project:
 
 ```
-"com.softwaremill.sttp.client4" %%% "core" % "4.0.13"
+"com.softwaremill.sttp.client4" %%% "core" % "4.0.14"
 ```
 
 and initialize one of the backends:
@@ -28,7 +28,7 @@ Try the following example:
 // hello.scala
 
 //> using platform native
-//> using dep com.softwaremill.sttp.client4::core_native0.5:4.0.13
+//> using dep com.softwaremill.sttp.client4::core_native0.5:4.0.14
 
 import sttp.client4.*
 import sttp.client4.curl.CurlBackend