feat: support function in params and commonParms

Author: BuptStEve

docs/config/common.md

@@ -91,6 +91,16 @@ export default {
 }
 ```
 
+::: tip
+<badge text="1.7.0+" /> 后，支持函数模式
+
+```js
+export default {
+    commonParams: (params) => ({ t: Date.now(), foo: params.foo }),
+}
+```
+:::
+
 ## axiosOptions 透传参数配置
 由于 tua-api 是依赖于 `axios` 或是 `fetch-jsop` 来发送请求的。所以势必要提供参数透传的功能。
 

docs/config/self.md

@@ -63,6 +63,24 @@ export default {
 }
 ```
 
+::: tip
+<badge text="1.7.0+" /> 后，支持函数模式
+
+```js
+export default {
+    pathList: [
+        {
+            ...
+            params: (params) => ({
+                t: Date.now(),
+                foo: params.foo,
+            }),
+        },
+    ],
+}
+```
+:::
+
 ## commonParams 覆盖公共参数
 有时某个接口正好不需要上一级中 `commonParams` 的参数。那么可以传递 `null` 覆盖上一级中的 `commonParams`。
 

examples/apis-web/fake-fn.js

@@ -0,0 +1,32 @@
+export default {
+    // 该参数表示请求的公用服务器地址。
+    baseUrl: 'http://example-base.com/',
+
+    // 请求的中间路径，建议与文件同名，以便后期维护。
+    prefix: 'fake-fn',
+
+    // 所有请求都需要携带的参数
+    commonParams: (args) => ({
+        ...args,
+        c: Math.random(),
+    }),
+
+    reqType: 'axios',
+
+    // 接口地址数组
+    pathList: [
+        /**
+        * fn-params
+        */
+        {
+            name: 'fp',
+            path: 'fn-params',
+            method: 'post',
+            params: ({ param1, param2 }) => ({
+                t: Math.random(),
+                p1: param1,
+                p2: param2,
+            }),
+        },
+    ],
+}

examples/apis-web/fake-post.js

@@ -19,10 +19,7 @@ export default {
         /**
          * empty-array-params
          */
-        {
-            name: 'eap',
-            path: 'empty-array-params',
-        },
+        { name: 'eap', path: 'empty-array-params' },
         /**
          * array-params
          */
@@ -84,10 +81,7 @@ export default {
         /**
          * application/json
          */
-        {
-            name: 'pj',
-            path: 'post-json',
-        },
+        { name: 'pj', path: 'post-json' },
         /**
          * raw-data
          */

examples/apis-web/index.d.ts

@@ -58,3 +58,12 @@ export const fakePostApi: {
 		): Promise<T>
 	}
 }
+
+export const fakeFnApi: {
+	'fp': ReqFn & {
+		<T = Result>(
+			params: { t?: any },
+			options?: RuntimeOptions
+		): Promise<T>
+	}
+}

examples/apis-web/index.js

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

package.json

@@ -1,6 +1,6 @@
 {
     "name": "tua-api",
-    "version": "1.6.1",
+    "version": "1.7.0",
     "description": "🏗 A common tool helps converting configs to api functions",
     "main": "dist/TuaApi.cjs.js",
     "module": "dist/TuaApi.esm.js",

src/index.d.ts

@@ -12,7 +12,7 @@ export type Mock = AnyFunction | any
 
 export type ApiConfig = WxApiConfig | WebApiConfig
 
-export type ParamsConfig = string[] | ParamsObject
+export type ParamsConfig = string[] | ParamsObject | ((args?: object) => object)
 
 export type Middleware<T> = (ctx: T, next: () => Promise<any>) => Promise<any>
 
@@ -96,7 +96,7 @@ export interface BaseApiConfig {
     beforeFn?: <T = any>() => Promise<T>
     middleware?: Middleware<Ctx>[]
     customFetch?: AnyPromiseFunction
-    commonParams?: object
+    commonParams?: object | ((args?: object) => object),
     axiosOptions?: AxiosOptions
     jsonpOptions?: JsonpOptions
     useGlobalMiddleware?: boolean

src/index.js

@@ -6,6 +6,7 @@ import {
     map,
     pipe,
     isWx,
+    runFn,
     logger,
     mergeAll,
     apiConfigToReqFnParams,
@@ -145,9 +146,7 @@ class TuaApi {
 
         // mock data
         if (mock) {
-            const resData = typeof mock === 'function'
-                ? mock(data)
-                : { ...mock }
+            const resData = { ...runFn(mock, data) }
 
             return Promise.resolve({ data: resData })
         }
@@ -255,7 +254,7 @@ class TuaApi {
         mock,
         name,
         path,
-        params = {},
+        params: rawParams = {},
         prefix,
         afterFn = ([x]) => x,
         beforeFn = Promise.resolve.bind(Promise),
@@ -308,6 +307,8 @@ class TuaApi {
         const apiFn = (args, runtimeOptions = {}) => {
             args = args || {}
 
+            const params = runFn(rawParams, args)
+
             // 最终的运行时配置，runtimeOptions 有最高优先级
             const runtimeParams = {
                 type,
@@ -361,7 +362,7 @@ class TuaApi {
 
         apiFn.key = `${prefix}/${apiName}`
         apiFn.mock = mock
-        apiFn.params = params
+        apiFn.params = rawParams
 
         return { [apiName]: apiFn }
     }

src/middlewareFns.js

@@ -1,5 +1,6 @@
 import { ERROR_STRINGS } from './constants'
 import {
+    runFn,
     isFormData,
     combineUrls,
     checkArrayParams,
@@ -59,7 +60,7 @@ const formatReqParamsMiddleware = (ctx, next) => {
     const {
         args,
         params,
-        commonParams,
+        commonParams: rawCommonParams,
     } = ctx.req
 
     if (typeof args !== 'object') {
@@ -74,10 +75,11 @@ const formatReqParamsMiddleware = (ctx, next) => {
 
     checkArrayParams(ctx.req)
 
+    const commonParams = runFn(rawCommonParams, args)
     // 根据配置生成请求的参数
     ctx.req.reqParams = Array.isArray(params)
         ? { ...commonParams, ...args }
-        : { ...getDefaultParamObj(ctx.req), ...args }
+        : { ...getDefaultParamObj({ ...ctx.req, commonParams }), ...args }
 
     return next()
 }