Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support various API Response Structures by allowing a callback to format Data

See original GitHub issue

Currently the plugin only supports a rigid API structure which does not include some of the popular standards like JSON:API given the example below for relationships.

Following JSON:API standard relationships will not be populated into models due to the response structure of the standard (see below).

{
    data: {
        id: 1,
        username: "test",
        relationships: {
            posts: {
                data: [{
                    id: 1,
                    title: "Title",
                    body: "Body",
                    user_id: 1,
                }]
            }
        }
    }
}

With the current implementation the response from the API is expected to be built for Vuex-ORM insertOrUpdate() expects an object of the following structure.

{
    data: {
        id: 1,
        username: "test",
        posts: [{
                id: 1,
                title: "Title",
                body: "Body",
                user_id: 1,
            }]
        }
    }
}

I there for suggest that we change:

  private getDataFromResponse (response: AxiosResponse, config: Config): any {
    if (!config.dataKey) {
      return response.data
    }

    return response.data[config.dataKey]
  }

To be:

  private getDataFromResponse(response: AxiosResponse, config: Config): any {
    if (!config.dataTransformer) {
      return response.data
    }

    return config.dataTransformer(response);
  }

This will allow the package to support any number of API response formats, by allowing the user to intercept and transform the response into a suitable format for Vue-ORM.