chore: 📦 add putWithFile method to support upload file on put method

Author: TouchSek

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-api-queries",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "Elegant and simple way to build requests for REST API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/__tests__/base-proxy.test.ts

@@ -108,6 +108,38 @@ describe('BaseProxy', () => {
     await proxy.post(form)
   })
 
+  it('transforms the data to a FormData object if there is a File with post', async () => {
+    const file = new File(['hello world!'], 'my-file')
+    const form = { id: 1, user: {}, file }
+    form.user = {
+      id: 1,
+      name: 'testFoo',
+      villages: ['testBar1', 'testBar2'],
+      date: new Date(Date.UTC(2012, 3, 13, 2, 12)),
+    }
+    mockAdapter.onPost('/posts/' + 1).reply((request) => {
+      expect(request.data).toBeInstanceOf(FormData)
+      expect(request.data.get('user[name]')).toBe('testFoo')
+      expect(request.data.get('user[villages][0]')).toBe('testBar1')
+      expect(request.data.get('user[villages][1]')).toBe('testBar2')
+      expect(request.data.get('user[date]')).toBe('2012-04-13T02:12:00.000Z')
+      expect(request.data.get('file')).toEqual(file)
+      expect(getFormDataKeys(request.data)).toEqual([
+        'id',
+        'user[id]',
+        'user[name]',
+        'user[villages][0]',
+        'user[villages][1]',
+        'user[date]',
+        'file',
+        '_method',
+      ])
+      return [200, {}]
+    })
+
+    await proxy.putWithFile(form.id, form)
+  })
+
   it('transforms the boolean values in FormData object to "1" or "0"', async () => {
     const file = new File(['hello world!'], 'myfile')
     const form = { field1: {}, field2: null }

src/core/BaseProxy.ts

@@ -42,6 +42,11 @@ class BaseProxy {
     return this.submit('put', `/${this.endpoint}/${id}`, payload)
   }
 
+  putWithFile(id: string | number, payload: any): Promise<any> {
+    payload['_method'] = 'put'
+    return this.submit('post', `/${this.endpoint}/${id}`, payload)
+  }
+
   patch(id: string | number, payload: any): Promise<any> {
     return this.submit('patch', `/${this.endpoint}/${id}`, payload)
   }

src/index.ts

@@ -5,6 +5,7 @@ import Validator from './core/Validator'
 import './vue'
 
 export type Errors = ValidatorType
+export type { ValidatorType }
 
 class VueApiQueries {
   install(Vue: any) {