how to send raw request?

[gadelkareem]

Is there a way to send a raw request? for ex I used to do something like this with https://github.com/twg/devour:

api.runMiddleware({
      url: api.apiUrl + '/users/' + id + '/password',
      method: 'PATCH',
      data,
      model: 'update-password-request'
})

[wopian]

As in without JSON:API (de)serialisation - just regular JSON (etc.) requests?

[gadelkareem]

No it is a jsonapi request but with a custom URL

[wopian]

There's nothing explicitly built-in to do that (middleware support would be a good feature request to make in a new issue).

However the Axios instance is exposed so you can construct a custom PATCH request yourself using the methods from kitsu-core.

E.g:

import Kitsu from 'kitsu'
import { serialise, deserialise } from 'kitsu-core'

const api = new Kitsu({ baseURL: 'https://example.com' })

const updatePassword = async (body) => {
  const { data } = await api.axios.patch(
	`users/${body.id}/password`, // Sends request to https://example.com/users/1/password
  	serialise('myModelType', body)
  )
  return deserialise(data)
}

updatePassword({ id: '1', password: 'myPassword' })

[wopian]

Although, deprecating the automatic extraction of type and id from the model parameter (first param of api.patch) would make it a plain URL. With the id and type attributes defined in the body parameter (second). Fully supporting this issue and arguably simplifying the library code.

Another weird choice I made years ago and yet another major breaking change if I go ahead with this in the future.

[wopian]

Moved this to #415 to discuss this change further for a future 10.x release. With changes proposed in #415 the code in OP would be the following with kitsu:

api.patch(`users/${id}/password`, data)

---

If #414 (comment) solves your issue in 9.x then you can close this issue 👍

[gadelkareem]

Thanks a lot for the quick answer. I think sending an object would simplify the call so I wonder if something like this would work?

import Kitsu from 'kitsu'
import { serialise, deserialise } from 'kitsu-core'

const api = new Kitsu({ baseURL: 'https://example.com' })

api.rawRequest = async (payload) => {
  const { data } = await api.axios.request({
    method: payload.method,
    url: payload.url,
    data: serialise(payload.model, payload.body)
  })
  return deserialise(data)
}

[wopian]

Added in e8aacc5

Documentation will be at https://github.com/wopian/kitsu/tree/master/packages/kitsu#request once it's released.

Until then, example usage is available in the JSDoc comments here: https://github.com/wopian/kitsu/blob/master/packages/kitsu/src/index.js#L366-L423

E.g

api.request({
  method: 'PATCH',
  url: 'anime',
  type: 'anime',
  body: { id: '1', subtype: 'tv' }
})

[wopian]

Released in 9.1.0

[gadelkareem]

@wopian I see the tests are passing but I still cannot call it from my app. I also do not see the declaration in the index.d.ts

[gadelkareem]

never mind it is working now v9.1.1