add withResponse option to HttpApiClient methods (#3884)

Effect-TS · Nov 4, 2024 · 07c493a · 07c493a
1 parent 257ab1b
commit 07c493a
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 8 deletions.
diff --git a/.changeset/ten-eels-joke.md b/.changeset/ten-eels-joke.md
@@ -0,0 +1,6 @@
+---
+"@effect/platform-node": patch
+"@effect/platform": patch
+---
+
+add withResponse option to HttpApiClient methods
diff --git a/packages/platform-node/examples/api.ts b/packages/platform-node/examples/api.ts
@@ -203,7 +203,7 @@ Effect.gen(function*() {
   user = yield* client.users.me()
   console.log("json me", user)
 
-  const csv = yield* client.csv()
+  const csv = yield* client.csv({ withResponse: true })
   console.log("csv", csv)
 
   const urlParams = yield* client.urlParams()

diff --git a/packages/platform-node/test/HttpApi.test.ts b/packages/platform-node/test/HttpApi.test.ts
@@ -179,6 +179,14 @@ describe("HttpApi", () => {
       }).pipe(Effect.provide(HttpLive)))
   })
 
+  it.effect("client withResponse", () =>
+    Effect.gen(function*() {
+      const client = yield* HttpApiClient.make(Api)
+      const [users, response] = yield* client.users.list({ headers: { page: 1 }, withResponse: true })
+      assert.strictEqual(users[0].name, "page 1")
+      assert.strictEqual(response.status, 200)
+    }).pipe(Effect.provide(HttpLive)))
+
   it("OpenAPI spec", () => {
     const spec = OpenApi.fromApi(Api)
     assert.deepStrictEqual(spec, OpenApiFixture as any)

diff --git a/packages/platform/src/HttpApiClient.ts b/packages/platform/src/HttpApiClient.ts
@@ -64,10 +64,10 @@ export declare namespace Client {
       infer _R,
       infer _RE
     >
-  ] ? (
-      request: Simplify<HttpApiEndpoint.ClientRequest<_Path, _UrlParams, _Payload, _Headers>>
+  ] ? <WithResponse extends boolean = false>(
+      request: Simplify<HttpApiEndpoint.ClientRequest<_Path, _UrlParams, _Payload, _Headers, WithResponse>>
     ) => Effect.Effect<
-      _Success,
+      WithResponse extends true ? [_Success, HttpClientResponse.HttpClientResponse] : _Success,
       _Error | GroupError | ApiError | HttpClientError.HttpClientError
     > :
     never
@@ -120,6 +120,7 @@ export const make = <Groups extends HttpApiGroup.Any, ApiError, ApiR>(
           number | "orElse",
           (response: HttpClientResponse.HttpClientResponse) => Effect.Effect<any, any>
         > = { orElse: statusOrElse }
+        const decodeResponse = HttpClientResponse.matchStatus(decodeMap)
         errors.forEach((ast, status) => {
           if (ast._tag === "None") {
             decodeMap[status] = statusCodeError
@@ -150,6 +151,7 @@ export const make = <Groups extends HttpApiGroup.Any, ApiError, ApiR>(
           readonly urlParams: any
           readonly payload: any
           readonly headers: any
+          readonly withResponse?: boolean
         }) => {
           const url = request && request.path ? makeUrl(request.path) : endpoint.path
           const baseRequest = HttpClientRequest.make(endpoint.method)(url)
@@ -184,8 +186,12 @@ export const make = <Groups extends HttpApiGroup.Any, ApiError, ApiR>(
                 )
                 : identity,
               Effect.flatMap(httpClient.execute),
-              Effect.flatMap(HttpClientResponse.matchStatus(decodeMap)),
-              options?.transformResponse === undefined ? identity : options.transformResponse,
+              Effect.flatMap((response) => {
+                const value = options?.transformResponse === undefined
+                  ? decodeResponse(response)
+                  : options.transformResponse(decodeResponse(response))
+                return request?.withResponse === true ? Effect.map(value, (value) => [value, response]) : value
+              }),
               Effect.scoped,
               Effect.catchIf(ParseResult.isParseError, Effect.die),
               Effect.mapInputContext((input) => Context.merge(context, input))

diff --git a/packages/platform/src/HttpApiEndpoint.ts b/packages/platform/src/HttpApiEndpoint.ts
@@ -402,14 +402,16 @@ export declare namespace HttpApiEndpoint {
    * @since 1.0.0
    * @category models
    */
-  export type ClientRequest<Path, UrlParams, Payload, Headers> = (
+  export type ClientRequest<Path, UrlParams, Payload, Headers, WithResponse extends boolean> = (
     & ([Path] extends [void] ? {} : { readonly path: Path })
     & ([UrlParams] extends [never] ? {} : { readonly urlParams: UrlParams })
     & ([Headers] extends [never] ? {} : { readonly headers: Headers })
     & ([Payload] extends [never] ? {}
       : [Payload] extends [Brand<HttpApiSchema.MultipartTypeId>] ? { readonly payload: FormData }
       : { readonly payload: Payload })
-  ) extends infer Req ? keyof Req extends never ? void : Req : void
+  ) extends infer Req ? keyof Req extends never ? (void | { readonly withResponse?: WithResponse }) :
+    Req & { readonly withResponse?: WithResponse } :
+    void
 
   /**
    * @since 1.0.0