feat(kitsu): add axios options for all operations (#623)

Co-authored-by: James Harris <wopian@wopian.me>

Author: justin-tay

packages/kitsu/src/delete.spec.js

@@ -10,6 +10,14 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('delete', () => {
+    it('uses provided axios options', async () => {
+      expect.assertions(1)
+      const api = new Kitsu()
+      api.axios = { delete: jest.fn().mockReturnValue({ data: '' }) }
+      await api.delete('anime', 1, { axiosOptions: { withCredentials: true } })
+      expect(api.axios.delete).toHaveBeenCalledWith('anime/1', expect.objectContaining({ withCredentials: true }))
+    })
+
     it('sends and recieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })

packages/kitsu/src/get.spec.js

@@ -19,6 +19,14 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('get', () => {
+    it('uses provided axios options', async () => {
+      expect.assertions(1)
+      const api = new Kitsu()
+      api.axios = { get: jest.fn().mockReturnValue({ data: '' }) }
+      await api.get('anime', { axiosOptions: { withCredentials: true } })
+      expect(api.axios.get).toHaveBeenCalledWith('anime', expect.objectContaining({ withCredentials: true }))
+    })
+
     it('sends and recieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { init: true } })

packages/kitsu/src/index.js

@@ -132,6 +132,7 @@ export default class Kitsu {
    * @param {number} [config.params.page.size] Number of resources to return in request (Page-based and cursor-based) - **Note:** Not supported on Kitsu.io
    * @param {string} [config.params.page.before] Get the previous page of resources (Cursor-based) - **Note:** Not Supported on Kitsu.io
    * @param {string} [config.params.page.after] Get the next page of resources (Cursor-based) - **Note:** Not Supported on Kitsu.io
+   * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
    * @returns {Object} JSON-parsed response
    * @example <caption>Getting a resource with JSON:API parameters</caption>
    * api.get('users', {
@@ -228,7 +229,8 @@ export default class Kitsu {
       const { data, headers: responseHeaders } = await this.axios.get(url, {
         headers,
         params,
-        paramsSerializer: /* istanbul ignore next */ p => query(p)
+        paramsSerializer: /* istanbul ignore next */ p => query(p),
+        ...config.axiosOptions
       })
 
       return responseHeaders ? { ...deserialise(data), ...{ headers: responseHeaders } } : deserialise(data)
@@ -246,6 +248,7 @@ export default class Kitsu {
    * @param {Object} [config] Additional configuration
    * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
    * @param {Object} [config.headers] Additional headers to send with the request
+   * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
    * @returns {Object|Object[]} JSON-parsed response
    * @example <caption>Update a resource</caption>
    * api.update('posts', {
@@ -289,7 +292,8 @@ export default class Kitsu {
         {
           headers,
           params,
-          paramsSerializer: /* istanbul ignore next */ p => query(p)
+          paramsSerializer: /* istanbul ignore next */ p => query(p),
+          ...config.axiosOptions
         }
       )
 
@@ -344,7 +348,8 @@ export default class Kitsu {
         {
           headers,
           params,
-          paramsSerializer: /* istanbul ignore next */ p => query(p)
+          paramsSerializer: /* istanbul ignore next */ p => query(p),
+          ...config.axiosOptions
         }
       )
 
@@ -363,6 +368,7 @@ export default class Kitsu {
    * @param {Object} [config] Additional configuration
    * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
    * @param {Object} [config.headers] Additional headers to send with the request
+   * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
    * @returns {Object|Object[]} JSON-parsed response
    * @example <caption>Remove a single resource</caption>
    * api.delete('posts', 123)
@@ -395,7 +401,8 @@ export default class Kitsu {
         }),
         headers,
         params,
-        paramsSerializer: /* istanbul ignore next */ p => query(p)
+        paramsSerializer: /* istanbul ignore next */ p => query(p),
+        ...config.axiosOptions
       })
 
       return responseHeaders ? { ...deserialise(data), ...{ headers: responseHeaders } } : deserialise(data)
@@ -413,6 +420,7 @@ export default class Kitsu {
    * @param {Object} [config] Additional configuration
    * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
    * @param {Object} [config.headers] Additional headers to send with the request
+   * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
    * @returns {Object} JSON-parsed response
    * @example <caption>Get the authenticated user's resource</caption>
    * api.self()
@@ -429,7 +437,7 @@ export default class Kitsu {
     try {
       const headers = { ...this.headers, ...config.headers }
       const params = { ...config.params, ...{ filter: { self: true } } }
-      const res = await this.get('users', { ...{ headers }, ...{ params } })
+      const res = await this.get('users', { ...{ headers }, ...{ params }, ...config.axiosOptions })
       return res.headers ? { ...{ data: res.data[0] }, ...{ headers: res.headers } } : { data: res.data[0] }
     } catch (E) {
       throw error(E)
@@ -449,6 +457,7 @@ export default class Kitsu {
    * @param {string} [config.method] Request method - `GET`, `PATCH`, `POST` or `DELETE` (defaults to `GET`, case-insensitive)
    * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
    * @param {Object} [config.headers] Additional headers to send with the request
+   * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
    * @returns {Object} JSON-parsed response
    * @example <caption>Raw GET request</caption>
    * api.request({
@@ -488,7 +497,7 @@ export default class Kitsu {
    *   ]
    * })
    */
-  async request ({ body, method, params, type, url, headers }) {
+  async request ({ body, method, params, type, url, headers, axiosOptions }) {
     try {
       method = method?.toUpperCase() || 'GET'
       const { data, headers: responseHeaders } = await this.axios.request({
@@ -502,7 +511,8 @@ export default class Kitsu {
           }),
         headers: { ...this.headers, ...headers },
         params,
-        paramsSerializer: /* istanbul ignore next */ p => query(p)
+        paramsSerializer: /* istanbul ignore next */ p => query(p),
+        ...axiosOptions
       })
 
       return responseHeaders ? { ...deserialise(data), ...{ headers: responseHeaders } } : deserialise(data)

packages/kitsu/src/patch.spec.js

@@ -14,6 +14,14 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('patch', () => {
+    it('uses provided axios options', async () => {
+      expect.assertions(1)
+      const api = new Kitsu()
+      api.axios = { patch: jest.fn().mockReturnValue({ data: '' }) }
+      await api.patch('anime', { id: '1', type: 'anime' }, { axiosOptions: { withCredentials: true } })
+      expect(api.axios.patch).toHaveBeenCalledWith('anime/1', { data: { id: '1', type: 'anime' } }, expect.objectContaining({ withCredentials: true }))
+    })
+
     it('sends and receieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })

packages/kitsu/src/post.spec.js

@@ -10,6 +10,14 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('post', () => {
+    it('uses provided axios options', async () => {
+      expect.assertions(1)
+      const api = new Kitsu()
+      api.axios = { post: jest.fn().mockReturnValue({ data: '' }) }
+      await api.post('anime', { id: '1', type: 'anime' }, { axiosOptions: { withCredentials: true } })
+      expect(api.axios.post).toHaveBeenCalledWith('anime', { data: { id: '1', type: 'anime' } }, expect.objectContaining({ withCredentials: true }))
+    })
+
     it('sends and recieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })

packages/kitsu/src/request.spec.js

@@ -29,6 +29,14 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('request', () => {
+    it('uses provided axios options', async () => {
+      expect.assertions(1)
+      const api = new Kitsu()
+      api.axios = { request: jest.fn().mockReturnValue({ data: '' }) }
+      await api.request({ axiosOptions: { withCredentials: true } })
+      expect(api.axios.request).toHaveBeenCalledWith(expect.objectContaining({ withCredentials: true }))
+    })
+
     it('sends and receives headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })

packages/kitsu/src/self.spec.js

@@ -13,6 +13,14 @@ afterEach(() => {
 
 describe('kitsu', () => {
   describe('self', () => {
+    it('uses provided axios options', async () => {
+      expect.assertions(1)
+      const api = new Kitsu()
+      api.get = jest.fn().mockReturnValue({ data: '', headers: '' })
+      await api.self({ axiosOptions: { withCredentials: true } })
+      expect(api.get).toHaveBeenCalledWith('users', expect.objectContaining({ withCredentials: true }))
+    })
+
     it('sends and recieves headers', async () => {
       expect.assertions(2)
       const api = new Kitsu({ headers: { Authorization: true } })

packages/kitsu/types/index.d.ts

@@ -58,10 +58,12 @@ export default class Kitsu {
                 after?: string;
             };
         };
+        axiosOptions?: any;
     }) => any;
     update: (model: string, body: any | any[], config?: {
         params?: any;
         headers?: any;
+        axiosOptions?: any;
     }) => any | any[];
     create: (model: string, body: any | any[], config?: {
         params?: any;
@@ -70,6 +72,7 @@ export default class Kitsu {
     remove: (model: string, id: string | number | number[], config?: {
         params?: any;
         headers?: any;
+        axiosOptions?: any;
     }) => any | any[];
     /**
      * Axios Interceptors (alias of `axios.interceptors`)
@@ -125,6 +128,7 @@ export default class Kitsu {
      * @param {number} [config.params.page.size] Number of resources to return in request (Page-based and cursor-based) - **Note:** Not supported on Kitsu.io
      * @param {string} [config.params.page.before] Get the previous page of resources (Cursor-based) - **Note:** Not Supported on Kitsu.io
      * @param {string} [config.params.page.after] Get the next page of resources (Cursor-based) - **Note:** Not Supported on Kitsu.io
+     * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
      * @returns {Object} JSON-parsed response
      * @example <caption>Getting a resource with JSON:API parameters</caption>
      * api.get('users', {
@@ -216,6 +220,7 @@ export default class Kitsu {
                 after?: string;
             };
         };
+        axiosOptions?: any;
     }): any;
     /**
      * Update a resource (alias `update`)
@@ -226,6 +231,7 @@ export default class Kitsu {
      * @param {Object} [config] Additional configuration
      * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
      * @param {Object} [config.headers] Additional headers to send with the request
+     * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
      * @returns {Object|Object[]} JSON-parsed response
      * @example <caption>Update a resource</caption>
      * api.update('posts', {
@@ -253,6 +259,7 @@ export default class Kitsu {
     patch(model: string, body: any | any[], config?: {
         params?: any;
         headers?: any;
+        axiosOptions?: any;
     }): any | any[];
     /**
      * Create a new resource (alias `create`)
@@ -295,6 +302,7 @@ export default class Kitsu {
      * @param {Object} [config] Additional configuration
      * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
      * @param {Object} [config.headers] Additional headers to send with the request
+     * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
      * @returns {Object|Object[]} JSON-parsed response
      * @example <caption>Remove a single resource</caption>
      * api.delete('posts', 123)
@@ -304,6 +312,7 @@ export default class Kitsu {
     delete(model: string, id: string | number | number[], config?: {
         params?: any;
         headers?: any;
+        axiosOptions?: any;
     }): any | any[];
     /**
      * Get the authenticated user's data
@@ -314,6 +323,7 @@ export default class Kitsu {
      * @param {Object} [config] Additional configuration
      * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
      * @param {Object} [config.headers] Additional headers to send with the request
+     * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
      * @returns {Object} JSON-parsed response
      * @example <caption>Get the authenticated user's resource</caption>
      * api.self()
@@ -329,6 +339,7 @@ export default class Kitsu {
     self(config?: {
         params?: any;
         headers?: any;
+        axiosOptions?: any;
     }): any;
     /**
      * Send arbitrary requests
@@ -343,6 +354,7 @@ export default class Kitsu {
      * @param {string} [config.method] Request method - `GET`, `PATCH`, `POST` or `DELETE` (defaults to `GET`, case-insensitive)
      * @param {Object} [config.params] JSON:API request queries. See [#get](#get) for documentation
      * @param {Object} [config.headers] Additional headers to send with the request
+     * @param {Object} [config.axiosOptions] Additional options for the axios instance (see [axios/axios#request-config](https://github.com/axios/axios#request-config) for details)
      * @returns {Object} JSON-parsed response
      * @example <caption>Raw GET request</caption>
      * api.request({
@@ -382,12 +394,13 @@ export default class Kitsu {
      *   ]
      * })
      */
-    request({ body, method, params, type, url, headers }?: {
+    request({ body, method, params, type, url, headers, axiosOptions }?: {
         url: string;
         type: string;
         body?: any | any[];
         method?: string;
         params?: any;
         headers?: any;
+        axiosOptions?: any;
     }): any;
 }