fix(kitsu-core): throw error if type is missing during serialisation

Author: wopian

packages/kitsu-core/src/serialise/index.js

@@ -12,6 +12,10 @@ import { error } from '../error'
 function isValid (isArray, type, payload, method) {
   const requireID = new Error(`${method} requires an ID for the ${type} type`)
 
+  if (type === undefined) {
+    throw new Error(`${method} requires a resource type`)
+  }
+
   if (isArray) {
     // A POST request is the only request to not require an ID in spec
     if (method !== 'POST' && payload.length > 0) {
@@ -21,7 +25,7 @@ function isValid (isArray, type, payload, method) {
     }
   } else {
     if (payload.constructor !== Object || Object.keys(payload).length === 0) {
-      throw new Error(`${method} requires a JSON object body`)
+      throw new Error(`${method} requires an object or array body`)
     }
     // A POST request is the only request to not require an ID in spec
     if (method !== 'POST' && !payload.id) {
@@ -133,6 +137,7 @@ function serialiseRootArray (type, payload, method, options) {
  */
 function serialiseRootObject (type, payload, method, options) {
   isValid(false, type, payload, method)
+  type = options.pluralTypes(options.camelCaseTypes(type))
   let data = { type }
 
   if (payload?.id) data.id = String(payload.id)
@@ -191,9 +196,6 @@ export function serialise (type, data = {}, method = 'POST', options = {}) {
     if (!options.pluralTypes) options.pluralTypes = s => s
     // Delete relationship to-one (data: null) or to-many (data: [])
     if (data === null || (Array.isArray(data) && data.length === 0)) return { data }
-
-    type = options.pluralTypes(options.camelCaseTypes(type))
-
     if (Array.isArray(data) && data?.length > 0) return serialiseRootArray(type, data, method, options)
     else return serialiseRootObject(type, data, method, options)
   } catch (E) {

packages/kitsu-core/src/serialise/index.spec.js

@@ -236,13 +236,13 @@ describe('kitsu-core', () => {
     it('throws an error if obj is missing', () => {
       expect.assertions(1)
       expect(() => serialise('post'))
-        .toThrowError('POST requires a JSON object body')
+        .toThrowError('POST requires an object or array body')
     })
 
     it('throws an error if obj is not an Object', () => {
       expect.assertions(1)
       expect(() => serialise('post', 'id: 1', 'DELETE'))
-        .toThrowError('DELETE requires a JSON object body')
+        .toThrowError('DELETE requires an object or array body')
     })
 
     it('throws an error when missing ID', () => {

packages/kitsu/MIGRATING.md

@@ -241,7 +241,7 @@ Unchanged from `3.x`, if there is an error thrown by `kitsu` itself, then you on
 ```js
 catch (err) {
 	err.name // 'Error'
-	err.message // 'POST requires a JSON object body'
+	err.message // 'POST requires an object or array body'
 }
 
 ## Migrating to `3.0.0`

packages/kitsu/src/index.js

@@ -189,9 +189,9 @@ export default class Kitsu {
       if (id) url += `/${id}`
       if (relationship) url += `/${this.resCase(relationship)}`
 
-      // eslint-disable-next-line no-console
       const { data } = await this.axios.get(url, {
         params,
+        /* istanbul ignore next */
         paramsSerializer: p => query(p),
         headers: Object.assign(this.headers, headers)
       })
@@ -425,7 +425,6 @@ export default class Kitsu {
   async request ({ body, method, params, type, url }, headers = {}) {
     try {
       method = method?.toUpperCase() || 'GET'
-      // eslint-disable-next-line no-console
       const { data } = await this.axios.request({
         method,
         url,
@@ -434,6 +433,7 @@ export default class Kitsu {
           pluralTypes: this.plural
         }),
         params,
+        /* istanbul ignore next */
         paramsSerializer: p => query(p),
         headers: Object.assign(this.headers, headers)
       })

packages/kitsu/src/patch.spec.js

@@ -59,7 +59,7 @@ describe('kitsu', () => {
       try {
         await api.patch('posts')
       } catch (err) {
-        expect(err.message).toEqual('PATCH requires a JSON object body')
+        expect(err.message).toEqual('PATCH requires an object or array body')
       }
     })
 

packages/kitsu/src/post.spec.js

@@ -95,7 +95,7 @@ describe('kitsu', () => {
       try {
         await api.post('posts')
       } catch (err) {
-        expect(err.message).toEqual('POST requires a JSON object body')
+        expect(err.message).toEqual('POST requires an object or array body')
       }
     })
   })

packages/kitsu/src/request.spec.js

@@ -142,9 +142,22 @@ describe('kitsu', () => {
       mock.onDelete('anime/1').reply(200, genericResponse)
       const request = await api.request({
         method: 'delete',
+        type: 'anime',
         url: 'anime/1'
       })
       expect(request).toEqual(genericRequest)
     })
+
+    it('throws an error if body is missing', async () => {
+      expect.assertions(1)
+      const api = new Kitsu()
+      try {
+        await api.request({
+          method: 'patch'
+        })
+      } catch (err) {
+        expect(err.message).toEqual('PATCH requires a resource type')
+      }
+    })
   })
 })