fix: close #13, add axios/fetch-jsonp as dependencies

README.md

@@ -40,26 +40,14 @@ $ yarn add tua-api
 import TuaApi from 'tua-api'
 ```
 
-#### 安装武器
-安装“武器”分为两种情况:
+#### 配置武器
+配置“武器”分为两种情况:
 
-* [已配置 CORS 跨域请求头](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Access_control_CORS)，或是没有跨域需求时，那么再装一个 `axios` 即可
+* [已配置 CORS 跨域请求头](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Access_control_CORS)，或是没有跨域需求时，无需任何操作（默认采用的就是 `axios`）。
 
-```bash
-$ npm i -S axios
-# OR
-$ yarn add axios
-```
-
-* 若是用不了 CORS，那么就需要装 `fetch-jsonp` 借助 jsonp 实现跨域
-
-```bash
-$ npm i -S fetch-jsonp
-# OR
-$ yarn add fetch-jsonp
-```
+* 若是用不了 CORS，那么就需要设置 `reqType: 'jsonp'` 借助 jsonp 实现跨域
 
-但是 jsonp 只支持使用 get 的方式请求，所以如果需要发送 post 或其他方式的请求，还是需要装 `axios`。
+但是 jsonp 只支持使用 get 的方式请求，所以如果需要发送 post 或其他方式的请求，还是需要使用 `axios`（服务端还是需要配置 CORS）。
 
 ### 小程序端
 #### 安装本体即可
@@ -73,7 +61,7 @@ $ yarn add tua-api
 ```js
 import TuaApi from 'tua-api'
 
-const tuaApi = new TuaApi({ reqType: 'wx' })
+const tuaApi = new TuaApi()
 ```
 
 > 小程序还用不了 npm？[@tua-mp/service](https://tuateam.github.io/tua-mp/tua-mp-service/) 了解一下？

docs/quick-start/installation.md

@@ -14,26 +14,14 @@ $ yarn add tua-api
 import TuaApi from 'tua-api'
 ```
 
-### 安装武器
-安装“武器”分为两种情况:
+#### 配置武器
+配置“武器”分为两种情况:
 
-* [已配置 CORS 跨域请求头](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Access_control_CORS)，或是没有跨域需求时，那么再装一个 `axios` 即可
+* [已配置 CORS 跨域请求头](https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Access_control_CORS)，或是没有跨域需求时，无需任何操作（默认采用的就是 `axios`）。
 
-```bash
-$ npm i -S axios
-# OR
-$ yarn add axios
-```
-
-* 若是用不了 CORS，那么就需要装 `fetch-jsonp` 借助 jsonp 实现跨域
-
-```bash
-$ npm i -S fetch-jsonp
-# OR
-$ yarn add fetch-jsonp
-```
+* 若是用不了 CORS，那么就需要设置 `reqType: 'jsonp'` 借助 jsonp 实现跨域
 
-但是 jsonp 只支持使用 get 的方式请求，所以如果需要发送 post 或其他方式的请求，还是需要装 `axios`。
+但是 jsonp 只支持使用 get 的方式请求，所以如果需要发送 post 或其他方式的请求，还是需要使用 `axios`（服务端还是需要配置 CORS）。
 
 ::: tip
 不推荐使用 jsonp 的方式，有以下几个原因：

examples/apis-mp/index.js

@@ -1,6 +1,6 @@
 import TuaApi from '../../src/TuaApi'
 
-const tuaApi = new TuaApi({ reqType: 'wx' })
+const tuaApi = new TuaApi()
 
 // 使用中间件
 tuaApi.use(async (ctx, next) => {
@@ -13,4 +13,4 @@ tuaApi.use(async (ctx, next) => {
     // console.log('after: ', ctx)
 })
 
-export const fakeWx = tuaApi.getApi(require('./fake-wx').default)
+export const fakeWxApi = tuaApi.getApi(require('./fake-wx').default)

examples/apis-web/index.js

@@ -17,5 +17,5 @@ tuaApi.use(async (ctx, next) => {
     // console.log('after: ', ctx)
 })
 
-export const fakeGet = tuaApi.getApi(require('./fake-get').default)
-export const fakePost = tuaApi.getApi(require('./fake-post').default)
+export const fakeGetApi = tuaApi.getApi(require('./fake-get').default)
+export const fakePostApi = tuaApi.getApi(require('./fake-post').default)

package.json

@@ -39,9 +39,6 @@
         "collectCoverage": true,
         "collectCoverageFrom": [
             "src/**"
-        ],
-        "setupFiles": [
-            "./test/__mocks__/wxMock.js"
         ]
     },
     "eslintIgnore": [
@@ -53,7 +50,6 @@
     "devDependencies": {
         "@commitlint/cli": "^7.2.1",
         "@commitlint/config-conventional": "^7.1.2",
-        "axios": "^0.18.0",
         "axios-mock-adapter": "^1.15.0",
         "babel-core": "^6.26.3",
         "babel-eslint": "^10.0.1",
@@ -70,7 +66,6 @@
         "eslint-plugin-node": "^8.0.0",
         "eslint-plugin-promise": "^4.0.1",
         "eslint-plugin-standard": "^4.0.0",
-        "fetch-jsonp": "^1.1.3",
         "gh-pages": "^2.0.1",
         "husky": "^1.1.4",
         "jest": "^23.6.0",
@@ -86,6 +81,8 @@
         "vuepress": "^0.14.4"
     },
     "dependencies": {
+        "axios": "^0.18.0",
+        "fetch-jsonp": "^1.1.3",
         "koa-compose": "^4.1.0"
     }
 }

src/TuaApi.js

@@ -4,6 +4,7 @@ import { version } from '../package.json'
 import {
     map,
     pipe,
+    isWx,
     logger,
     mergeAll,
     apiConfigToReqFnParams,
@@ -25,7 +26,6 @@ import {
 } from './middlewareFns'
 
 logger.log(`Version: ${version}`)
-
 class TuaApi {
     /**
      * @param {Object} options
@@ -38,7 +38,7 @@ class TuaApi {
      */
     constructor ({
         host,
-        reqType = 'axios',
+        reqType = isWx() ? 'wx' : 'axios',
         middleware = [],
         axiosOptions = {},
         jsonpOptions = {},

src/utils/env.js

@@ -0,0 +1,3 @@
+export const isWx = () =>
+    typeof wx !== 'undefined' &&
+    typeof wx.request === 'function'

src/utils/index.js

@@ -1,4 +1,5 @@
 export * from './fp'
 export * from './mp'
+export * from './env'
 export * from './logger'
 export * from './params'

test/__tests__/axios.test.js

@@ -1,19 +1,19 @@
 import axios from 'axios'
 import MockAdapter from 'axios-mock-adapter'
 
-import { fakeGet, fakePost } from '../../examples/apis-web/'
+import { fakeGetApi, fakePostApi } from '../../examples/apis-web/'
 
 const mock = new MockAdapter(axios)
 
 const params = {
     param1: 'steve',
     param2: 'young',
 }
-const reqOH = fakePost['own-host']
-const reqAP = fakePost['array-params']
-const reqOP = fakePost['object-params']
-const reqTA = fakeGet['req-type-axios']
-const reqEAP = fakePost['empty-array-params']
+const reqOH = fakePostApi['own-host']
+const reqAP = fakePostApi['array-params']
+const reqOP = fakePostApi['object-params']
+const reqTA = fakeGetApi['req-type-axios']
+const reqEAP = fakePostApi['empty-array-params']
 
 const reqAPUrl = `http://example-base.com/fake-post/array-params`
 const reqOPUrl = `http://example-base.com/fake-post/object-params`

test/__tests__/core.test.js

@@ -1,4 +1,3 @@
-import fakeGet from '../../examples/apis-mp/fake-wx'
 import TuaApi from '../../src/TuaApi'
 
 describe('error handling', () => {
@@ -12,27 +11,3 @@ describe('error handling', () => {
         expect(() => new TuaApi({ reqType: '' })).toThrow(TypeError(`invalid reqType`))
     })
 })
-
-describe('middleware', () => {
-    const tuaApi = new TuaApi({ reqType: 'wx' })
-    const globalMiddlewareFn = jest.fn(async (ctx, next) => {
-        await next()
-
-        expect(ctx.endTime).toBeDefined()
-        expect(ctx.reqTime).toBeDefined()
-    })
-    tuaApi.use(globalMiddlewareFn)
-
-    const fakeGetApi = tuaApi.getApi(fakeGet)
-
-    beforeEach(() => {
-        wx.__TEST_DATA__ = { testData: {} }
-    })
-
-    test('useGlobalMiddleware', async () => {
-        await fakeGetApi.arrayData()
-        expect(globalMiddlewareFn).toBeCalledTimes(0)
-        await fakeGetApi.fail()
-        expect(globalMiddlewareFn).toBeCalledTimes(1)
-    })
-})

test/__tests__/jsonp.test.js

@@ -1,13 +1,13 @@
 import fetchJsonp from 'fetch-jsonp'
 
-import { fakeGet } from '../../examples/apis-web/'
+import { fakeGetApi } from '../../examples/apis-web/'
 
 jest.mock('fetch-jsonp')
 
-const reqAP = fakeGet['array-params']
-const reqOP = fakeGet['object-params']
-const reqACP = fakeGet['async-common-params']
-const reqIRT = fakeGet['invalid-req-type']
+const reqAP = fakeGetApi['array-params']
+const reqOP = fakeGetApi['object-params']
+const reqACP = fakeGetApi['async-common-params']
+const reqIRT = fakeGetApi['invalid-req-type']
 
 const returnVal = { code: 0, data: 'array data' }
 

test/__tests__/wx.test.js

@@ -1,17 +1,44 @@
-import { fakeWx } from '../../examples/apis-mp/'
-
-const reqF = fakeWx['fail']
-const reqAD = fakeWx.arrayData
-const reqOD = fakeWx['object-data']
-const reqNB = fakeWx['no-beforeFn']
-const reqHL = fakeWx['hide-loading']
-const reqTG = fakeWx['type-get']
-const reqUT = fakeWx['unknown-type']
-const reqNL = fakeWx['nav-loading']
+import '../__mocks__/wxMock'
+import TuaApi from '../../src/TuaApi'
+import fakeWx from '../../examples/apis-mp/fake-wx'
+import { fakeWxApi } from '../../examples/apis-mp/'
+
+const reqF = fakeWxApi['fail']
+const reqAD = fakeWxApi.arrayData
+const reqOD = fakeWxApi['object-data']
+const reqNB = fakeWxApi['no-beforeFn']
+const reqHL = fakeWxApi['hide-loading']
+const reqTG = fakeWxApi['type-get']
+const reqUT = fakeWxApi['unknown-type']
+const reqNL = fakeWxApi['nav-loading']
 
 const testObjData = { code: 0, data: 'object data' }
 const testArrData = [ 0, 'array data' ]
 
+describe('middleware', () => {
+    const tuaApi = new TuaApi()
+    const fakeWxApi = tuaApi.getApi(fakeWx)
+    const globalMiddlewareFn = jest.fn(async (ctx, next) => {
+        await next()
+
+        expect(ctx.endTime).toBeDefined()
+        expect(ctx.reqTime).toBeDefined()
+    })
+
+    tuaApi.use(globalMiddlewareFn)
+
+    beforeEach(() => {
+        wx.__TEST_DATA__ = { testData: {} }
+    })
+
+    test('useGlobalMiddleware', async () => {
+        await fakeWxApi.arrayData()
+        expect(globalMiddlewareFn).toBeCalledTimes(0)
+        await fakeWxApi.fail()
+        expect(globalMiddlewareFn).toBeCalledTimes(1)
+    })
+})
+
 describe('fake wx requests', () => {
     beforeEach(() => {
         wx.__TEST_DATA__ = {}