@uxda/appkit 1.0.64 → 1.0.70

package/src/shared/http/Http.ts

@@ -1,99 +1,82 @@
-/**
- * 
- */
-
-
+import { HttpInstance, HttpClientConfig,
+  HttpMethod, HttpRequestConfig,
+  RequestData, ResponseData,
+  ResponseRaw } from './types'
 /**
  * Useage:
- * const $http = useHttp()
+ * const $http = createHttp({
+ *
+ * })
  * $http.get('/url').then(data => {
- *  
+ *
  * })
  */
 
-import Taro from '@tarojs/taro'
-import { Http, HttpClientConfig, HttpMethod, HttpRequestConfig, RequestData, ResponseData, ResponseRaw } from './types'
-
-/**
- * 场景配置
- * 本地后台团队统一返回值外层
- */
-const defaultClientConfig: HttpClientConfig = {
-  baseUrl: 'https://ytech.ddjf.com',
-  response: {
-    getCode: (data: ResponseRaw) => data.code,
-    getMessage: (data: ResponseRaw) => data.msg,
-    getData: (data: ResponseRaw) => data.result
-  },
-  interceptors: {
-    auth: (data) => data.code == '401',
-    server: (data) => false,
-  }
-}
-
-let clientConfig = {
-  ...defaultClientConfig
-}
-
 /**
  * 统一请求过程
- * @param config 
- * @returns 
+ * @param config
+ * @returns
  */
-const request: Http['request'] = <T>(config: HttpRequestConfig) => {
-  clientConfig = {
+const request: HttpInstance['request'] = <T>(config: HttpRequestConfig) => {
+  const c = {
     ...clientConfig,
     ...config,
   }
   return new Promise<T>((resolve, reject) => {
     const data = config.data
       && clientConfig.translates
-      && clientConfig.translates[config.url]
-        ? clientConfig.translates[config.url](config.data)
-        : config.data
-    console.log(`[][][][][][][][][][][][] HTTP.${config.method}, ${clientConfig.baseUrl}${config.url}`, data)
-    Taro.request<ResponseData>({
-      url: `${clientConfig.baseUrl}${config.url}`,
+      && clientConfig.translates[c.url]
+        ? clientConfig.translates[c.url]?.(c.data || {})
+        : c.data
+    console.log(`[][][][][]HTTP.${c.method}, ${c.baseUrl}${c.url}`, data)
+    clientConfig.vendor?.request({
+      url: `${c.baseUrl}${c.url}`,
       data,
-      header: clientConfig.header,
-      method: config.method,
-      success (res: Taro.request.SuccessCallbackResult<ResponseRaw>) {
-        if (!isSuccess(res)) {
-          // 拦截 statusCode
-          reject(`==接口报错==${res.statusCode}`)
-          reject({})
-        }
-        const { data: raw } = res
-        if (clientConfig.interceptors?.auth(raw)) {
-          //拦截 401
-          clientConfig.onAuthError?.()
-          reject('===401===')
-        }
-        if (clientConfig.interceptors?.server(raw)) {
-          // 拦截后端错误
-          clientConfig.onServerError?.()
-          reject('server error')
+      headers: c.headers,
+      method: c.method,
+    }).then((raw: ResponseRaw) => {
+      // 按顺序执行拦截器
+      for (const interc of c.interceptors || []) {
+        const r = interc(raw)
+        if (r) {
+          // 某拦截器命中时
+          // 按拦截结果 决定是否继续执行
+          reject('===INTERCEPTED===' + raw.status)
+          return false
         }
-        const response = clientConfig.response?.getData(raw)
-        if (response) {
-          // 当用户配置含有 transforms 时, 使用用户提供的 transform
-          resolve(clientConfig.transforms
-            && clientConfig.transforms[config.url]
-              ? clientConfig.transforms[config.url](response) as T
-              : response as T)
-        } else {
-          // 拦截业务异常
-          reject(`==接口报错==${raw.msg}`)
-        }
-      },
-      fail (res) {
-        console.log('HTTP failed', res)
       }
+      if (raw.data) {
+        // 当用户配置含有 transforms 时, 使用用户提供的 transform
+        // 先 endpoints transform
+        // 再组装分页数据
+        const response = clientConfig.transforms
+          && clientConfig.transforms[c.url]
+            ? clientConfig.transforms[c.url]?.(raw.data) as T
+            : data as T
+        // 前端要求分页
+        // 在 endpoints transform 之前格式化分页数据
+        // 并拼装回原 raw 数据
+        const paging = config.data?.page
+          ? clientConfig.paging?.transform(raw.data)
+          : void 0
+        resolve(
+          paging
+            ? {
+                ...paging,
+                data: response
+              } as T
+            : response
+        )
+      } else {
+        reject(`未知错误`)
+      }
+    }).catch((e: any) => {
+      console.log('request.catch===', e)
     })
   })
 }
 
-const get: Http['get'] = <T>(url: string, data?: RequestData) => {
+const get: HttpInstance['get'] = <T = ResponseData>(url: string, data?: RequestData) => {
   return request<T>({
     url,
     data,
@@ -101,7 +84,7 @@ const get: Http['get'] = <T>(url: string, data?: RequestData) => {
   })
 }
 
-const post: Http['post'] = <T>(url: string, data: RequestData) => {
+const post: HttpInstance['post'] = <T = ResponseData>(url: string, data: RequestData) => {
   return request<T>({
     url,
     data,
@@ -110,12 +93,26 @@ const post: Http['post'] = <T>(url: string, data: RequestData) => {
 }
 
 /**
- * 写入配置并
- * @param config 
- * @returns 
+ * 场景配置
+ * 本地后台团队统一返回值外层
  */
-export function useHttp (config: HttpClientConfig): Http {
+const defaultClientConfig: HttpClientConfig = {
+  baseUrl: '/',
+  interceptors: [
+    (raw) => raw.status == 401,
+  ]
+}
 
+let clientConfig = {
+  ...defaultClientConfig
+}
+
+/**
+ * 写入配置并返回 HTTP instance
+ * @param config
+ * @returns
+ */
+export function createHttp (config: HttpClientConfig): HttpInstance {
   clientConfig = {
     ...defaultClientConfig,
     ...config
@@ -127,9 +124,3 @@ export function useHttp (config: HttpClientConfig): Http {
     post
   }
 }
-
-
-
-function isSuccess (res: Taro.request.SuccessCallbackResult<ResponseRaw>) {
-  return /^2/.test(res.statusCode.toString())
-}

package/src/shared/http/types.ts

@@ -1,53 +1,83 @@
+/**
+ * 由使用场景提供的配置
+ * createHttp() 使用的配置
+ */
+export type HttpClientConfig = {
+  vendor?: HttpVendor,
+  baseUrl: string,
+  /**
+   * 向 HTTP header 加入的数据
+   * 通常含有 JWT token 以及其他参数
+   */
+  headers?: HeaderParams,
+  paging?: Paging,
+  /**
+   * 拦截器组
+   * 请求返回异常时进行一定的操作
+   */
+  interceptors?: HttpInterceptor[],
+  translates?: HttpTranslates,
+  transforms?: HttpTransforms,
+}
+
+/**
+ * HTTP 请求的底层实现
+ * Axios/Taro.request
+ */
+export type HttpVendor = {
+  request <T = ResponseData>(config: HttpRequestConfig): Promise<ResponseRaw<T>>
+}
+
+export type HttpInterceptor = (raw: ResponseRaw) => boolean
+
+/**
+ * Request Config for request API
+ * 沿用 Axios 的部分配置
+ */
+export type HttpRequestConfig<D = RequestData> = {
+  url: string,
+  method?: HttpMethod,
+  baseUrl?: string,
+  headers?: HeaderData,
+  data?: D,
+}
 
+/**
+ * Request data for http get & post method
+ */
 export type RequestData = Record<string, any>
 
 /**
- * 本地后端团队的接口数据格式
+ * 接口请求返回的标准格式
  */
-export type ResponseRaw = Record<string, any>
+export type ResponseRaw<T = ResponseData> = {
+  status: number,
+  message: string,
+  data: T
+}
 
-export type ResponseData = Record<string, any>
+/**
+ * 拆箱之后前端拿到的数据
+ */
+export type ResponseData = Record<string, any> | any[]
 
-export type HttpTranslates = Record<string, (data: RequestData) => RequestData>
-export type HttpTransforms = Record<string, (data: ResponseData) => ResponseData>
+export type HttpInstance = {
+  request<T = ResponseData>(config: HttpRequestConfig): Promise<T>
+  get<T = ResponseData>(url: string, data?: RequestData): Promise<T>,
+  post<T = ResponseData>(url: string, data?: RequestData): Promise<T>,
+}
 
 /**
- * 向 request header 加入参数
- * 多数是 token
+ *
  */
-export type HeaderParams = Record<string, string>
+export type HttpTranslates = Record<string, HttpTranslate | undefined>
+export type HttpTransforms = Record<string, HttpTransform | undefined>
 
 /**
- * 由使用场景提供的配置
+ * 向 request header 加入参数
+ * 多数是 token
  */
-export type HttpClientConfig = {
-  baseUrl: string,
-  /**
-   * 向 HTTP header 加入的数据
-   * 通常含有 JWT token 以及其他参数
-   */
-  header?: HeaderParams
-  /**
-   * 定义返回数据的外层格式
-   */
-  response?: {
-    getCode (data: ResponseData): `${number}` | number,
-    getMessage (data: RequestData): string,
-    getData (data: ResponseData): ResponseData
-  },
-  onAuthError? (): void
-  onServerError? (): void
-  /**
-   * 错误码配置
-   * 依据后端给出的 code 定义错误类型及处理方法
-   */
-  interceptors?: {
-    auth (data: ResponseData): boolean
-    server (data: ResponseData): boolean
-  },
-  translates?: HttpTranslates
-  transforms?: HttpTransforms
-}
+export type HeaderParams = Record<string, string>
 
 export enum HttpMethod {
   get = 'GET',
@@ -61,17 +91,7 @@ export enum HttpError {
   server = 'server'
 }
 
-export type Http = {
-  request<T = ResponseData>(config: HttpRequestConfig): Promise<T>
-  get<T = ResponseData>(url: string, data?: RequestData): Promise<T>,
-  post<T = ResponseData>(url: string, data?: RequestData): Promise<T>,
-}
-
-export type HttpRequestConfig = {
-  url: string,
-  data?: RequestData,
-  method?: HttpMethod
-}
+export type HeaderData = Record<string, string>
 
 /**
  * 接口参数转换器
@@ -97,4 +117,42 @@ export type HttpEndpoint = {
  */
 export type HttpEndpoints = {
   [name: string]: HttpEndpoint
+}
+
+/**
+ * 分页参数
+ */
+export type PagingParams = {
+  /**
+   * 页数
+   */
+  page: number,
+  /**
+   * 页数据条数
+   */
+  pageSize: number,
+}
+
+export type PagingData = {
+  /**
+   * 页总数
+   */
+  totalPages: number,
+}
+
+/**
+ * Wrapped with Paging Data
+ */
+export type WithPaging<T = ResponseData> = {
+  [K in keyof PagingData]: PagingData[K];
+} & {
+  data: T;
+}
+
+/**
+ * 分页设置
+ */
+export type Paging = {
+  translate (params: PagingParams): any,
+  transform (resonse: any): PagingData,
 }

package/src/shared/index.ts

@@ -1,3 +1,4 @@
 export * from './weixin'
 export * from './components'
+export * from './composables'
 export * from './http'