Refactor few coding styles and types

Author: kiaking

docs/guide/configurations.md

@@ -57,11 +57,11 @@ The lower level configuration will overwrite a higher level of configs. Which me
 
 All Axios configurations are available. For those, please refer to [the Axios documentation](https://github.com/axios/axios#request-config). In addition to Axios options, Vuex ORM Axios takes few more options specific to the plugin usage.
 
-### dataTransformer
+### dataKey
 
-- **`dataTransformer?: ((response: AxiosResponse) => object)`**
+- **`dataKey?: string | null`**
 
-  This option will let you transform the response before send it to the store. Let's say your response from the server looks like below.
+  This option will define which key to look for when persisting response data. Let's say your response from the server looks like below.
 
   ```js
   {
@@ -73,50 +73,64 @@ All Axios configurations are available. For those, please refer to [the Axios do
   }
   ```
 
-  For these situations, you can use `dataTransform` property to specify how you want to transform the data. The whole response is send as callback param.
+  In this case, data persistent to the store will probably fail, since actual data is inside the `data` key, but Vuex ORM Axios is going to insert whole object including `ok` property.
+
+  For these situations, you can use `dataKey` property to specify which key to look for data.
 
   ```js
   User.api().get('/api/users', {
-    dataTransformer: ({ data, headers }) => {
-      // Do stuff with headers
-      // Do stuff with data
-
-      return data.data
-    }
+    dataKey: 'data'
   })
   ```
 
   With the above config, the data inside `data` key will be inserted to the store.
 
-  It is very useful when you need to transform a given response to be handle by Vuex ORM. For instance, if you format your response with the [JSON:API specs](https://jsonapi.org/), you can transform your response with this callback.
+  > **NOTE:** When `dataTransformer` key is set, this option will be ignored.
 
-### dataKey
+### dataTransformer
 
-- **`dataKey?: string | null`**
+- **`dataTransformer?: ((response: AxiosResponse) => Record | Record[])`**
 
-  This option will define which key to look for when persisting response data. Let's say your response from the server looks like below.
+  This option will let you transform the response before persisting it to the store. Let's say your response from the server looks like below.
 
   ```js
   {
     ok: true,
-    data: {
+    record: {
       id: 1,
       name: 'John Doe'
     }
   }
   ```
 
-  In this case, data persistent to the store will probably fail, since actual data is inside the `data` key, but Vuex ORM Axios is going to insert whole object including `ok` property.
+  You can use `dataTransform` property to specify how you want to transform the data. The whole Axios response will be passed as callback argument.
 
-  For these situations, you can use `dataKey` property to specify which key to look for data.
+  ```js
+  User.api().get('/api/users', {
+    dataTransformer: (response) => {
+      return response.data.record
+    }
+  })
+  ```
+
+  With the above config, the data inside `record` key will be inserted to the store.
+
+  It is very useful when you need to transform a given response to be handle by Vuex ORM. For instance, if you format your response with the [JSON:API specs](https://jsonapi.org/), you can transform your response with this callback.
+
+  You can always use object destructuring to get specific properties from the response object too.
 
   ```js
   User.api().get('/api/users', {
-    dataKey: 'data'
+    dataTransformer: ({ data, headers }) => {
+      // Do stuff with headers...
+      // Do stuff with data...
+
+      return data
+    }
   })
   ```
 
-  With the above config, the data inside `data` key will be inserted to the store.
+  > **NOTE:** When `dataTransformer` key is set, `dataKey` option will be ignored.
 
 ### save
 

package.json

@@ -78,6 +78,7 @@
     "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
     "collectCoverageFrom": [
       "src/**/*.ts",
+      "!src/index.cjs.ts",
       "!**/node_modules/**"
     ],
     "coverageReporters": [

src/api/Request.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance, AxiosResponse } from 'axios'
-import { Model } from '@vuex-orm/core'
+import { Model, Record, Collections } from '@vuex-orm/core'
 import Config from '../contracts/Config'
 import Response from './Response'
 
@@ -140,13 +140,15 @@ export default class Request {
   /**
    * Persist the response data to the vuex store.
    */
-  private async persistResponseData (response: AxiosResponse, config: Config): Promise<any> {
+  private async persistResponseData (response: AxiosResponse, config: Config): Promise<Collections | null> {
     if (!config.save) {
       return null
     }
 
     if (config.delete !== undefined) {
-      return this.model.delete(config.delete as any)
+      await this.model.delete(config.delete as any)
+
+      return null
     }
 
     return this.model.insertOrUpdate({
@@ -156,10 +158,10 @@ export default class Request {
 
   /**
    * Get data from the given response object. If the `dataTransformer` config is
-   * provided, it tries to execute the method with the response as param.
-   * If the `dataKey` config is provided, it tries to fetch the data at that key.
+   * provided, it tries to execute the method with the response as param. If the
+   * `dataKey` config is provided, it tries to fetch the data at that key.
    */
-  private getDataFromResponse (response: AxiosResponse, config: Config): any {
+  private getDataFromResponse (response: AxiosResponse, config: Config): Record | Record[] {
     if (config.dataTransformer) {
       return config.dataTransformer(response)
     }

src/api/Response.ts

@@ -1,5 +1,5 @@
 import { AxiosResponse } from 'axios'
-import { Model } from '@vuex-orm/core'
+import { Model, Collections } from '@vuex-orm/core'
 import Config from '../contracts/Config'
 
 export default class Response {
@@ -21,12 +21,12 @@ export default class Response {
   /**
    * Entities created by Vuex ORM.
    */
-  entities: any
+  entities: Collections | null
 
   /**
    * Create a new response instance.
    */
-  constructor (model: typeof Model, config: Config, response: AxiosResponse, entities: any) {
+  constructor (model: typeof Model, config: Config, response: AxiosResponse, entities: Collections | null) {
     this.model = model
     this.config = config
     this.response = response

src/contracts/Config.ts

@@ -1,9 +1,9 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios'
-import { Model } from '@vuex-orm/core'
+import { Model, Record } from '@vuex-orm/core'
 
 export interface Config extends AxiosRequestConfig {
-  dataKey?: string,
-  dataTransformer?: ((response: AxiosResponse) => object),
+  dataKey?: string
+  dataTransformer?: ((response: AxiosResponse) => Record | Record[])
   save?: boolean
   delete?: string | number | ((model: Model) => boolean)
   actions?: {