feat: return header object when present

closes #575

Author: wopian

packages/kitsu/MIGRATING.md

@@ -45,6 +45,16 @@ The `headers` parameter has been merged with the existing `config` parameter
 
 `Kitsu.request(config?, headers?)` is now `Kitsu.request(config? { headers? })`
 
+### Response Changes
+
+1. The header object is now returned in requests when headers are returned by the API. You can now do the following for all requests:
+
+    `const { data, headers } = await api.get('products')`
+
+2. `api.self` now returns data within a `data` object to support the header object without conflicting with attribute names:
+
+    `await api.self()` now returns `{ data: { name: 'wopian' }, headers?: {} }` instead of `{ name: 'wopian' }`
+
 ### Serialisation Changes
 
 This change does not affect `Kitsu.get`.

packages/kitsu/src/delete.spec.js

@@ -10,8 +10,8 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('delete', () => {
-    it('sends headers', done => {
-      expect.assertions(1)
+    it('sends and recieves headers', async () => {
+      expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })
       mock.onDelete('/anime/1').reply(config => {
         expect(config.headers).toEqual({
@@ -20,12 +20,15 @@ describe('kitsu', () => {
           Authorization: true,
           extra: true
         })
-        return [ 200 ]
+        return [ 200, undefined, {
+          Accept: 'application/vnd.api+json'
+        } ]
       })
-      api.delete('anime', 1, { headers: { extra: true } }).catch(err => {
-        done.fail(err)
+      expect(await api.delete('anime', 1, { headers: { extra: true } })).toEqual({
+        headers: {
+          Accept: 'application/vnd.api+json'
+        }
       })
-      done()
     })
 
     it('sends data in request', async () => {

packages/kitsu/src/get.spec.js

@@ -18,7 +18,7 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('get', () => {
-    it('sends headers', async () => {
+    it('sends and recieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { init: true } })
       mock.onGet('/anime').reply(config => {
@@ -28,10 +28,21 @@ describe('kitsu', () => {
           init: true,
           extra: true
         })
-        return [ 200, { data: [] } ]
+        return [ 200, { data: [] }, {
+          Accept: 'application/vnd.api+json',
+          'Content-Type': 'application/vnd.api+json',
+          extra: true
+        } ]
       })
-      await expect(await api.get('anime', { headers: { extra: true } })).toEqual({
-        data: []
+      const response = await api.get('anime', { headers: { extra: true } })
+      console.log(response)
+      await expect(await response).toEqual({
+        data: [],
+        headers: {
+          Accept: 'application/vnd.api+json',
+          'Content-Type': 'application/vnd.api+json',
+          extra: true
+        }
       })
     })
 

packages/kitsu/src/index.js

@@ -225,13 +225,13 @@ export default class Kitsu {
       // :resource/:id/:relationship/:subRelationship
       if (subRelationship) url += `/${this.resCase(subRelationship)}`
 
-      const { data } = await this.axios.get(url, {
+      const { data, headers: responseHeaders } = await this.axios.get(url, {
         headers,
         params,
         paramsSerializer: /* istanbul ignore next */ p => query(p)
       })
 
-      return deserialise(data)
+      return responseHeaders ? merge(deserialise(data), { headers: responseHeaders }) : deserialise(data)
     } catch (E) {
       throw error(E)
     }
@@ -283,7 +283,7 @@ export default class Kitsu {
         pluralTypes: this.plural
       })
       const fullURL = body?.id ? `${url}/${body.id}` : url
-      const { data } = await this.axios.patch(
+      const { data, headers: responseHeaders } = await this.axios.patch(
         fullURL,
         serialData,
         {
@@ -293,7 +293,7 @@ export default class Kitsu {
         }
       )
 
-      return deserialise(data)
+      return responseHeaders ? merge(deserialise(data), { headers: responseHeaders }) : deserialise(data)
     } catch (E) {
       throw error(E)
     }
@@ -335,7 +335,7 @@ export default class Kitsu {
         resourceCase: this.resCase,
         pluralModel: this.plural
       })
-      const { data } = await this.axios.post(
+      const { data, headers: responseHeaders } = await this.axios.post(
         url,
         serialise(resourceModel, body, 'POST', {
           camelCaseTypes: this.camel,
@@ -348,7 +348,7 @@ export default class Kitsu {
         }
       )
 
-      return deserialise(data)
+      return responseHeaders ? merge(deserialise(data), { headers: responseHeaders }) : deserialise(data)
     } catch (E) {
       throw error(E)
     }
@@ -388,7 +388,7 @@ export default class Kitsu {
         payload = { id }
       }
 
-      const { data } = await this.axios.delete(path, {
+      const { data, headers: responseHeaders } = await this.axios.delete(path, {
         data: serialise(resourceModel, payload, 'DELETE', {
           camelCaseTypes: this.camel,
           pluralTypes: this.plural
@@ -398,7 +398,7 @@ export default class Kitsu {
         paramsSerializer: /* istanbul ignore next */ p => query(p)
       })
 
-      return data
+      return responseHeaders ? merge(deserialise(data), { headers: responseHeaders }) : deserialise(data)
     } catch (E) {
       throw error(E)
     }
@@ -430,7 +430,7 @@ export default class Kitsu {
       const headers = merge(this.headers, config.headers)
       const params = merge(config.params, { filter: { self: true } })
       const res = await this.get('users', merge({ headers }, { params }))
-      return res.data[0]
+      return res.headers ? merge({ data: res.data[0] }, { headers: res.headers }) : { data: res.data[0] }
     } catch (E) {
       throw error(E)
     }
@@ -491,7 +491,7 @@ export default class Kitsu {
   async request ({ body, method, params, type, url, headers }) {
     try {
       method = method?.toUpperCase() || 'GET'
-      const { data } = await this.axios.request({
+      const { data, headers: responseHeaders } = await this.axios.request({
         method,
         url,
         data: [ 'GET', 'DELETE' ].includes(method)
@@ -505,7 +505,7 @@ export default class Kitsu {
         paramsSerializer: /* istanbul ignore next */ p => query(p)
       })
 
-      return deserialise(data)
+      return responseHeaders ? merge(deserialise(data), { headers: responseHeaders }) : deserialise(data)
     } catch (E) {
       throw error(E)
     }

packages/kitsu/src/patch.spec.js

@@ -14,7 +14,7 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('patch', () => {
-    it('sends headers', async () => {
+    it('sends and receieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })
       mock.onPatch('/anime/1').reply(config => {
@@ -24,9 +24,15 @@ describe('kitsu', () => {
           Authorization: true,
           extra: true
         })
-        return [ 200 ]
+        return [ 200, undefined, {
+          Accept: 'application/vnd.api+json'
+        } ]
+      })
+      await expect(await api.patch('anime', { id: '1', type: 'anime' }, { headers: { extra: true } })).toEqual({
+        headers: {
+          Accept: 'application/vnd.api+json'
+        }
       })
-      await expect(await api.patch('anime', { id: '1', type: 'anime' }, { headers: { extra: true } })).toBeUndefined()
     })
 
     it('sends data in request', async () => {

packages/kitsu/src/post.spec.js

@@ -10,7 +10,7 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('post', () => {
-    it('sends headers', async () => {
+    it('sends and recieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })
       mock.onPost('/anime').reply(config => {
@@ -20,9 +20,15 @@ describe('kitsu', () => {
           Authorization: true,
           extra: true
         })
-        return [ 200 ]
+        return [ 200, undefined, {
+          Accept: 'application/vnd.api+json'
+        } ]
+      })
+      await expect(await api.post('anime', { id: '1', type: 'anime' }, { headers: { extra: true } })).toEqual({
+        headers: {
+          Accept: 'application/vnd.api+json'
+        }
       })
-      await expect(await api.post('anime', { id: '1', type: 'anime' }, { headers: { extra: true } })).toBeUndefined()
     })
 
     it('sends data in request', async () => {

packages/kitsu/src/request.spec.js

@@ -29,7 +29,7 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('request', () => {
-    it('sends headers', async () => {
+    it('sends and receives headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })
       mock.onGet('/users').reply(config => {
@@ -39,14 +39,14 @@ describe('kitsu', () => {
           Authorization: true,
           extra: true
         })
-        return [ 200, { data: [] } ]
+        return [ 200, { data: [] }, { Accept: 'application/vnd.api+json' } ]
       })
       await expect(await api.request({
         method: 'GET',
         url: 'users',
         model: 'users',
         headers: { extra: true }
-      })).toEqual({ data: [] })
+      })).toEqual({ data: [], headers: { Accept: 'application/vnd.api+json' } })
     })
 
     it('sends parameters', async () => {

packages/kitsu/src/self.spec.js

@@ -13,7 +13,7 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('self', () => {
-    it('sends headers', async () => {
+    it('sends and recieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })
       mock.onGet('/users', { filter: { self: true } }).reply(config => {
@@ -23,9 +23,11 @@ describe('kitsu', () => {
           Authorization: true,
           extra: true
         })
-        return [ 200, { data: [] } ]
+        return [ 200, { data: [] }, { Accept: 'application/vnd.api+json' } ]
+      })
+      await expect(await api.self({ headers: { extra: true } })).toEqual({
+        headers: { Accept: 'application/vnd.api+json' }
       })
-      await expect(await api.self({ headers: { extra: true } })).toBeUndefined()
     })
 
     it('fetches the authenticated user', async () => {
@@ -41,9 +43,11 @@ describe('kitsu', () => {
         ]
       })
       expect(await api.self()).toEqual({
-        id: '1',
-        type: 'users',
-        name: 'John'
+        data: {
+          id: '1',
+          type: 'users',
+          name: 'John'
+        }
       })
     })