refactor!: 🔥 rename BaseProxy class to BaseService class

Author: chantouchsek

README.md

@@ -10,7 +10,7 @@ This package helps you quickly to build requests for REST API. Move your logic a
 classes. Keep your code clean and elegant.
 
 Wouldn't it be great if you could just use your back end to validate forms on the front end? This package provides a
-`BaseProxy` class that does exactly that. It can post itself to a configured endpoint and manage errors. The class is
+`BaseService` class that does exactly that. It can post itself to a configured endpoint and manage errors. The class is
 meant to be used with a Laravel back end, and it doesn't limit that you need only to work with laravel, Ruby on Rail,
 NodeJs, ExpressJs, or any other languages.
 
@@ -130,9 +130,9 @@ It will create `$errors` object inside components.
 `~/proxies/NewsProxy.js`
 
 ```js
-import { BaseProxy } from 'vue-axios-http'
+import { BaseService } from 'vue-axios-http'
 
-class NewsProxy extends BaseProxy {
+class NewsProxy extends BaseService {
   constructor(parameters = {}) {
     super('news', parameters)
   }

nuxt/templates/plugin.js

@@ -1,12 +1,12 @@
 import Vue from 'vue'
-import AxiosHttp, { BaseProxy, Validator } from 'vue-axios-http'
+import AxiosHttp, { BaseService, Validator } from 'vue-axios-http'
 
 const errorProperty = '<%= options.errorProperty %>'
 const parsedQs = '<%= options.parsedQs %>'
 
 Vue.use(AxiosHttp, { errorProperty: errorProperty, parsedQs })
 
 export default function ({ $axios }, inject) {
-  BaseProxy.$http = $axios
+  BaseService.$http = $axios
   inject('errors', Validator)
 }

src/__tests__/base-proxy.test.ts renamed to src/__tests__/base-service.test.ts

@@ -1,28 +1,28 @@
 import Axios from 'axios'
-import BaseProxy from '../core/BaseProxy'
+import BaseService from '../core/BaseService'
 import MockAdapter from 'axios-mock-adapter'
-import PostProxy from '../util/PostPorxy'
+import PostService from '../util/PostService'
 import type { ValidatorType } from '../core/Validator'
 import Validator from '../core/Validator'
 import { merge } from '../util'
 
-let proxy: PostProxy
+let proxy: PostService
 let mockAdapter: MockAdapter
 let validator: ValidatorType
 
-describe('BaseProxy', () => {
+describe('BaseService', () => {
   beforeEach(() => {
     validator = Validator
     const axios = Axios.create({ baseURL: 'https://mock-api.test' })
-    BaseProxy.$http = axios
-    BaseProxy.$errorProperty = 'message'
-    proxy = new PostProxy()
+    BaseService.$http = axios
+    BaseService.$errorProperty = 'message'
+    proxy = new PostService()
     mockAdapter = new MockAdapter(axios)
     mockAdapter.reset()
   })
 
   it('check if http was installed', async () => {
-    BaseProxy.$http = undefined as any
+    BaseService.$http = undefined as any
     try {
       await proxy.all()
     } catch (e) {
@@ -346,10 +346,10 @@ describe('BaseProxy', () => {
   })
 
   it('can accept a custom http instance in options', () => {
-    BaseProxy.$http = Axios.create({ baseURL: 'https://another-example.com' })
+    BaseService.$http = Axios.create({ baseURL: 'https://another-example.com' })
     expect(proxy.$http.defaults.baseURL).toBe('https://another-example.com')
 
-    BaseProxy.$http = Axios.create()
+    BaseService.$http = Axios.create()
     expect(proxy.$http.defaults.baseURL).toBe(undefined)
   })
 })

src/__tests__/post-proxy.spec.ts renamed to src/__tests__/post-service.spec.ts

@@ -1,16 +1,16 @@
 import Axios from 'axios'
-import BaseProxy from '../core/BaseProxy'
-import PostProxy from '../util/PostPorxy'
+import BaseService from '../core/BaseService'
+import PostService from '../util/PostService'
 import MockAdapter from 'axios-mock-adapter'
 
-let proxy: PostProxy
+let proxy: PostService
 let mockAdapter: MockAdapter
 
-describe('PostProxy', () => {
+describe('PostService', () => {
   beforeEach(() => {
     const axios = Axios.create({ baseURL: 'https://mock-api.test' })
-    BaseProxy.$http = axios
-    proxy = new PostProxy()
+    BaseService.$http = axios
+    proxy = new PostService()
     mockAdapter = new MockAdapter(axios)
     mockAdapter.reset()
   })

src/core/BaseProxy.ts renamed to src/core/BaseService.ts

@@ -18,7 +18,7 @@ import qs, { IParseOptions } from 'qs'
 const validator = Validator
 const UNPROCESSABLE_ENTITY = 422
 
-class BaseProxy {
+class BaseService {
   errors: Errors
   parameters: Record<string, any>
   endpoint: string
@@ -37,15 +37,15 @@ class BaseProxy {
   }
 
   get $http() {
-    return BaseProxy.$http
+    return BaseService.$http
   }
 
   get $errorProperty() {
-    return BaseProxy.$errorProperty
+    return BaseService.$errorProperty
   }
 
   get $parsedQs() {
-    return BaseProxy.$parsedQs
+    return BaseService.$parsedQs
   }
 
   all<T>() {
@@ -129,7 +129,7 @@ class BaseProxy {
     form?: T,
     config?: AxiosRequestConfig,
   ): Promise<T> {
-    const method = BaseProxy.__validateRequestType(requestType)
+    const method = BaseService.__validateRequestType(requestType)
     this.beforeSubmit()
     return new Promise((resolve, reject) => {
       const data = hasFiles(form) ? objectToFormData(form) : form
@@ -255,4 +255,4 @@ class BaseProxy {
   }
 }
 
-export default BaseProxy
+export default BaseService

src/index.ts

@@ -1,5 +1,5 @@
 import type { ValidatorType } from './core/Validator'
-import BaseProxy from './core/BaseProxy'
+import BaseService from './core/BaseService'
 import Validator from './core/Validator'
 import { merge } from './util'
 import _Vue from 'vue'
@@ -28,9 +28,9 @@ class AxiosHttp {
       options,
     )
     const { $axios, errorProperty, parsedQs } = defaultOption
-    BaseProxy.$http = $axios
-    BaseProxy.$errorProperty = errorProperty || 'errors'
-    BaseProxy.$parsedQs = parsedQs || this.parsedQs
+    BaseService.$http = $axios
+    BaseService.$errorProperty = errorProperty || 'errors'
+    BaseService.$parsedQs = parsedQs || this.parsedQs
     Vue.mixin({
       beforeCreate() {
         this.$options.$errors = {} as any
@@ -49,6 +49,6 @@ class AxiosHttp {
     })
   }
 }
-export { Validator, BaseProxy, BaseProxy as BaseService }
+export { Validator, BaseService }
 export * from './util'
 export default new AxiosHttp()

src/util/PostPorxy.ts renamed to src/util/PostService.ts

@@ -1,6 +1,6 @@
-import BaseProxy from '../core/BaseProxy'
+import BaseService from '../core/BaseService'
 
-class PostProxy extends BaseProxy {
+class PostService extends BaseService {
   constructor(parameters = {}) {
     super('posts', parameters)
   }
@@ -14,4 +14,4 @@ class PostProxy extends BaseProxy {
   }
 }
 
-export default PostProxy
+export default PostService