feat: adds form-data and url encoded support

Author: joelgallant

package.json

@@ -41,6 +41,7 @@
   },
   "dependencies": {
     "@lcdev/ts": "0.2",
+    "isomorphic-form-data": "2",
     "query-string": "6"
   },
   "prettier": "@lcdev/prettier",

src/index.test.ts

@@ -329,4 +329,29 @@ describe('serialization options', () => {
       body: JSON.stringify([1, 2, 3]),
     });
   });
+
+  test('form data', () => {
+    expect(
+      apiCall('/', HttpMethod.POST)
+        .withFormDataBody({ foo: 'bar' })
+        .build(),
+    ).toMatchObject({
+      path: '/',
+      body: expect.any(FormData),
+    });
+  });
+
+  test('url encoded', () => {
+    expect(
+      apiCall('/', HttpMethod.POST)
+        .withURLEncodedBody({ foo: 'bar' })
+        .build(),
+    ).toMatchObject({
+      path: '/',
+      headers: new Headers({
+        'content-type': 'application/x-www-form-urlencoded',
+      }),
+      body: expect.any(URLSearchParams),
+    });
+  });
 });

src/index.ts

@@ -1,6 +1,8 @@
 import { stringify as stringifyQuery } from 'query-string';
 import { Json } from '@lcdev/ts';
 
+import 'isomorphic-form-data';
+
 export enum HttpMethod {
   GET = 'GET',
   POST = 'POST',
@@ -36,16 +38,22 @@ export interface ApiCall<Method extends HttpMethod> extends Promise<Response> {
   readonly body?: Json | BodyInit;
 
   withQuery(query: Query, options?: SerializationOptions): ApiCall<Method>;
-  withBearerToken(token: BearerToken): ApiCall<Method>;
-  withContentType(contentType: string): ApiCall<Method>;
+
   withHeaders(headers: Headers): ApiCall<Method>;
   withHeader(name: string, value: string): ApiCall<Method>;
+  withContentType(contentType: string): ApiCall<Method>;
+  withBearerToken(token: BearerToken): ApiCall<Method>;
+
   withBody<B extends Json | BodyInit>(
     body: B,
     json?: boolean,
     options?: SerializationOptions,
   ): ApiCall<Method>;
 
+  withJsonBody<B extends Json>(body: B, options?: SerializationOptions): ApiCall<Method>;
+  withFormDataBody<B extends Query>(data: B, options?: SerializationOptions): ApiCall<Method>;
+  withURLEncodedBody<B extends Query>(data: B, options?: SerializationOptions): ApiCall<Method>;
+
   expectStatus(code: number): ApiCall<Method>;
   expectSuccessStatus(): ApiCall<Method>;
 
@@ -145,6 +153,30 @@ class ApiCallImpl<Method extends HttpMethod> implements ApiCall<Method> {
     return this;
   }
 
+  withJsonBody<B extends Json>(body: B, options?: SerializationOptions) {
+    return this.withBody(body, true, options);
+  }
+
+  withFormDataBody<B extends Query>(data: B, options?: SerializationOptions) {
+    const body = new FormData();
+
+    for (const [k, v] of Object.entries(data)) {
+      if (v) body.append(k, `${v}`);
+    }
+
+    return this.withBody(body, false, options);
+  }
+
+  withURLEncodedBody<B extends Query>(data: B, options?: SerializationOptions) {
+    const body = new URLSearchParams();
+
+    for (const [k, v] of Object.entries(data)) {
+      if (v) body.append(k, `${v}`);
+    }
+
+    return this.withContentType('application/x-www-form-urlencoded').withBody(body, false, options);
+  }
+
   expectStatus(code: number) {
     return this.onResponse(res => {
       if (res.status !== code) {

yarn.lock

@@ -2031,6 +2031,15 @@ forever-agent@~0.6.1:
   resolved "https://registry.yarnpkg.com/forever-agent/-/forever-agent-0.6.1.tgz#fbc71f0c41adeb37f96c577ad1ed42d8fdacca91"
   integrity sha1-+8cfDEGt6zf5bFd60e1C2P2sypE=
 
+form-data@^2.3.2:
+  version "2.5.1"
+  resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.5.1.tgz#f2cbec57b5e59e23716e128fe44d4e5dd23895f4"
+  integrity sha512-m21N3WOmEEURgk6B9GLOE4RuWOFf28Lhh9qGYeNlGq4VDXUlJy2th2slBNU8Gp8EzloYZOibZJ7t5ecIrFSjVA==
+  dependencies:
+    asynckit "^0.4.0"
+    combined-stream "^1.0.6"
+    mime-types "^2.1.12"
+
 form-data@~2.3.2:
   version "2.3.3"
   resolved "https://registry.yarnpkg.com/form-data/-/form-data-2.3.3.tgz#dcce52c05f644f298c6a7ab936bd724ceffbf3a6"
@@ -2572,6 +2581,13 @@ isobject@^3.0.0, isobject@^3.0.1:
   resolved "https://registry.yarnpkg.com/isobject/-/isobject-3.0.1.tgz#4e431e92b11a9731636aa1f9c8d1ccbcfdab78df"
   integrity sha1-TkMekrEalzFjaqH5yNHMvP2reN8=
 
+isomorphic-form-data@2:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/isomorphic-form-data/-/isomorphic-form-data-2.0.0.tgz#9f6adf1c4c61ae3aefd8f110ab60fb9b143d6cec"
+  integrity sha512-TYgVnXWeESVmQSg4GLVbalmQ+B4NPi/H4eWxqALKj63KsUrcu301YDjBqaOw3h+cbak7Na4Xyps3BiptHtxTfg==
+  dependencies:
+    form-data "^2.3.2"
+
 isstream@~0.1.2:
   version "0.1.2"
   resolved "https://registry.yarnpkg.com/isstream/-/isstream-0.1.2.tgz#47e63f7af55afa6f92e1500e690eb8b8529c099a"