chore(methods)!: remvoe redundant methods from base proxy class

Author: chantouchsek

src/__tests__/base-proxy.test.ts

@@ -24,7 +24,7 @@ describe('BaseProxy', () => {
   it('check if http was installed', async () => {
     BaseProxy.$http = undefined as any
     try {
-      await proxy.getMany()
+      await proxy.all()
     } catch (e) {
       const { message } = e as any
       expect(message).toBe('Vue Axios Http, No http library provided.')
@@ -167,7 +167,7 @@ describe('BaseProxy', () => {
   it('it should find an item by id', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onGet('posts/1').reply(200, { data: item })
-    const { data } = await proxy.getOne(1)
+    const { data } = await proxy.find(1)
     expect(data).toEqual(item)
   })
 
@@ -178,15 +178,6 @@ describe('BaseProxy', () => {
     expect(data).toEqual(item)
   })
 
-  it('it should create items with bulk', async () => {
-    const item = {
-      bulk: [{ first_name: 'Chantouch', last_name: 'Sek', id: 1 }],
-    }
-    mockAdapter.onPost('/posts/bulk').reply(201, item)
-    const data = await proxy.createMany(item)
-    expect(data).toEqual(item)
-  })
-
   it('transforms the data to a FormData object if there is a File', async () => {
     const file = new File(['hello world!'], 'myfile')
     const form: any = { field1: {}, field2: {}, files: [] }
@@ -308,7 +299,7 @@ describe('BaseProxy', () => {
   it('it should be able to put item', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onPut('posts/1').reply(200, { data: item })
-    const { data } = await proxy.replace(item.id, item)
+    const { data } = await proxy.put(item.id, item)
     expect(data).toEqual(item)
   })
 

src/__tests__/post-proxy.spec.ts

@@ -24,7 +24,7 @@ describe('PostProxy', () => {
       },
     }
     mockAdapter.onGet('/posts/1/tags').reply(200, items)
-    const { data, meta } = await proxy.tags(1)
+    const { data, meta } = await proxy.removeParameters([]).tags(1)
     const item = {
       items: data,
       pagination: meta.pagination,

src/core/BaseProxy.ts

@@ -43,103 +43,34 @@ class BaseProxy {
     return BaseProxy.$parsedQs
   }
 
-  /**
-   * Get all or by pagination
-   */
   all<T>() {
     return this.submit<T>('get')
   }
 
-  /**
-   * Alternative of all method
-   */
-  getMany<T>() {
-    return this.all<T>()
-  }
-
-  /**
-   * Find a record by id
-   * @param {string|number} id
-   */
   find<T>(id: number | string) {
     return this.submit<T>('get', id)
   }
 
-  /**
-   * Alternative of find method
-   * @param {string | number} id
-   */
-  getOne<T>(id: number | string) {
-    return this.find<T>(id)
-  }
-
-  /**
-   * Create record
-   * @param {Object|string} payload
-   * @param {AxiosRequestConfig} config
-   */
   post<T>(payload: any, config?: AxiosRequestConfig) {
     return this.submit<T>('post', '', payload, config)
   }
 
-  /**
-   * Alternative of post method
-   * @param payload
-   * @param {AxiosRequestConfig} config
-   */
   store<T>(payload: any, config?: AxiosRequestConfig) {
     return this.post<T>(payload, config)
   }
 
-  /**
-   * Alternative of store method
-   * @param payload
-   * @param {AxiosRequestConfig} config
-   */
   create<T>(payload: any, config?: AxiosRequestConfig) {
     return this.store<T>(payload, config)
   }
 
-  /**
-   * Create many items
-   * @param {Object} payload
-   */
-  createMany<T>(payload: T) {
-    return this.submit<T>('post', 'bulk', payload)
-  }
-
-  /**
-   * Update record by id using PUT method
-   * @param {string|number} id
-   * @param {Object|string} payload
-   */
   put<T>(id: string | number, payload: any) {
     return this.submit<T>('put', `/${id}`, payload)
   }
 
-  /**
-   * Update record without ID parameter by using PUT method
-   * @param {Object|string} payload
-   */
   putWithoutId<T>(payload: any) {
     return this.submit<T>('put', '', payload)
   }
 
-  /**
-   * Alternative of put method
-   * @param {string|number} id
-   * @param {Object|string} payload
-   */
-  replace<T>(id: string | number, payload: any) {
-    return this.put<T>(id, payload)
-  }
-
-  /**
-   * This method helpful for laravel developer
-   * @param {string|number} id
-   * @param {Object} payload
-   * @param config
-   */
   putWithFile<T>(
     id: string | number,
     payload: any,
@@ -149,47 +80,35 @@ class BaseProxy {
     return this.submit<T>('post', `/${id}`, payload, config)
   }
 
-  /**
-   * Update record by id
-   * @param id
-   * @param payload
-   */
   patch<T>(id: string | number, payload: any) {
     return this.submit<T>('patch', `/${id}`, payload)
   }
 
-  /**
-   * Alternative of path method
-   * @param {string|number} id
-   * @param {Object|string} payload
-   */
   update<T>(id: string | number, payload: any) {
     return this.patch<T>(id, payload)
   }
 
-  /**
-   * Delete record by id
-   * @param {string|number} id
-   */
   delete<T>(id: string | number) {
     return this.submit<T>('delete', `/${id}`)
   }
 
-  /**
-   * Alternative of delete method
-   * @param {string|number} id
-   */
   remove<T>(id: string | number) {
     return this.delete<T>(id)
   }
 
-  /**
-   * Main endpoint method to handle requests
-   * @param requestType
-   * @param {string} parameter
-   * @param {Object|string} form
-   * @param {AxiosRequestConfig} config
-   */
+  submit<T = any>(requestType: Method): Promise<T>
+  submit<T = any>(requestType: Method, parameter?: string | number): Promise<T>
+  submit<T = any>(
+    requestType: Method,
+    parameter?: string | number,
+    form?: T,
+  ): Promise<T>
+  submit<T = any>(
+    requestType: Method,
+    parameter?: string | number,
+    form?: T,
+    config?: AxiosRequestConfig,
+  ): Promise<T>
   submit<T = any>(
     requestType: Method,
     parameter?: string | number,
@@ -260,22 +179,13 @@ class BaseProxy {
     return requestType
   }
 
-  /**
-   * Set parameters by keys
-   * @param {Object} parameters
-   */
   setParameters(parameters: Record<string, any>): this {
     Object.keys(parameters).forEach((key) => {
       this.parameters[key] = parameters[key]
     })
     return this
   }
 
-  /**
-   * Set parameters by key
-   * @param {string} parameter
-   * @param {Object|string|Array} value
-   */
   setParameter(parameter: string, value?: any): this {
     if (!value) {
       const options: IParseOptions = Object.assign({}, this.$parsedQs, {
@@ -290,10 +200,6 @@ class BaseProxy {
     return this
   }
 
-  /**
-   * Remove parameters by keys
-   * @param {Array<Object>>} parameters
-   */
   removeParameters(parameters = [] as any[]): this {
     if (!parameters.length) {
       this.parameters = []
@@ -305,27 +211,16 @@ class BaseProxy {
     return this
   }
 
-  /**
-   * Remove parameters
-   * @param {string} parameter
-   */
   removeParameter(parameter: string): this {
     delete this.parameters[parameter]
     return this
   }
 
-  /**
-   * Fill errors on fails passed
-   * @param {Object} errors
-   */
   onFail(errors: Record<string, any>) {
     this.errors.fill(errors)
     validator.fill(errors)
   }
 
-  /**
-   * Clean up errors and set processing
-   */
   beforeSubmit() {
     if (!this.$http) {
       throw new Error('Vue Axios Http, No http library provided.')
@@ -338,9 +233,6 @@ class BaseProxy {
     validator.successful = false
   }
 
-  /**
-   * Clean up errors and set success on after request
-   */
   onSuccess() {
     this.errors.processing = false
     this.errors.successful = true