yunxi-request 0.3.5

package/README.md

@@ -0,0 +1,94 @@
+# Crop / 裁剪
+
+> Owner 徐绍平
+
+## 安装
+
+```shell
+yarn add @yunxi/request
+```
+
+## 创建 http 实例
+
+```typescript
+const axiosOpts = {
+  baseURL:
+    import.meta.env.MODE === 'development' ? '/api' : <string>import.meta.env.VITE_APP_BASE_API,
+  timeout: 1000 * 10,
+};
+
+const handleRequest = (config: AxiosRequestConfig) => {
+  if (config.headers) {
+    config.headers.authorization = <string>storeHelper.get('y-token');
+    config.headers.source = '6';
+  }
+  return config;
+};
+
+// 创建 http实例
+export const http = new HttpServer(axiosOpts, {
+  // debugger: true,
+  handleRequest,
+  errorHandle: async response => {
+    switch (response.code) {
+      case 401:
+        message.error('您未登录，或者登录已经超时，请先登录！');
+        await toLogin();
+        break;
+      case 500:
+        message.error('服务器内部错误！');
+        break;
+      default:
+        message.error(<string>response.msg || '请求出错，请检查');
+        break;
+    }
+  },
+});
+
+// 不走errorHandle 返回axios 原始数据
+// 适用 特殊接口需要走自定义catch的逻辑
+export const rawHttp = new HttpServer(axiosOpts, {
+  raw: true,
+  handleRequest,
+});
+```
+
+## 接口调用
+
+```typescript
+import { http, rawHttp } from '../http-server';
+
+export function liveDecorationTempInfo(data: { templateId: string }) {
+  return http.get<ITempData>('/live/decorate/get-template', data);
+}
+
+export function liveDecorationTempCreate(data: ITempData) {
+  return rawHttp.post('/live/decorate/create-template', data);
+}
+```
+
+## 配置
+
+```typescript
+export type IErrorHandle = (args: IResponseData, response?: AxiosResponse) => void;
+export type IHandleRequest = (config: AxiosRequestConfig) => void;
+
+// 后端返回数据结构
+export interface IResponseData<T = any> {
+  code: number;
+  data: T;
+  msg: string;
+  total: number;
+  trace: string;
+  statusCode?: number; // 老接口兼容
+  message?: string;
+}
+
+// 自定义配置
+export interface ICustomConfig {
+  raw?: boolean; // 是否返回axios 原始数据，不处理handleResponse
+  debugger?: boolean; // 是否开启 debugger 模式
+  errorHandle?: IErrorHandle; // 错误处理函数
+  handleRequest?: IHandleRequest;
+}
+```

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "yunxi-request",
+  "version": "0.3.5",
+  "description": "基于axios的请求库",
+  "author": "xushaoping <xusp@yunxi.tv>",
+  "license": "ISC",
+  "main": "lib/index.umd.js",
+  "module": "lib/index.es.js",
+  "typings": "types/index.d.ts",
+  "files": [
+    "lib",
+    "src",
+    "types"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,102 @@
+import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { IErrorHandle, IHandleRequest, IResponseData, ICustomConfig } from './types';
+
+const defaultConfig: AxiosRequestConfig = {
+  baseURL: '',
+  method: 'get',
+  timeout: 1000 * 10,
+  withCredentials: false,
+};
+
+const defaultCustomConfig: ICustomConfig = {
+  raw: false,
+  errorHandle: undefined,
+  handleRequest: undefined,
+  debugger: false,
+};
+
+export default class HttpServer {
+  private instance: AxiosInstance;
+  private readonly debugger: boolean | undefined;
+
+  constructor(options?: AxiosRequestConfig, customOptions?: ICustomConfig) {
+    const config = Object.assign(defaultConfig, options);
+    const customConfig = Object.assign(defaultCustomConfig, customOptions);
+    this.instance = axios.create(config);
+    this.debugger = customOptions?.debugger;
+
+    if (customConfig.handleRequest) {
+      this.handleRequest(customConfig.handleRequest);
+    }
+    if (!customConfig.raw && customConfig.errorHandle) {
+      this.handleResponse(customConfig.errorHandle);
+    }
+  }
+
+  private handleRequest(handle: IHandleRequest) {
+    this.instance.interceptors.request.use(
+      config => {
+        if (this.debugger) {
+          console.log('请求 config 打印', config);
+        }
+        return handle(config);
+      },
+      error => {
+        return Promise.reject(error);
+      },
+    );
+  }
+
+  private handleResponse(errorHandle: IErrorHandle) {
+    // 响应请求的拦截器
+    this.instance.interceptors.response.use(
+      response => {
+        if (this.debugger) {
+          console.log('请求 response 打印', response);
+        }
+
+        // 请求 blob 时直接返回数据 ，不做拦截处理
+        if (response.request.responseType === 'blob') return response.data;
+
+        const data: IResponseData = response.data;
+        const code = data.code || data.statusCode;
+        if (code === 200) return data;
+        errorHandle(data, response);
+        return Promise.reject(data);
+      },
+      (error: Error) => {
+        const response: IResponseData = {
+          code: +error.message.slice(-3),
+          data: {},
+          msg: error.message,
+          total: 0,
+          trace: '',
+        };
+        errorHandle(response);
+        return Promise.reject(response);
+      },
+    );
+  }
+
+  async get<T = any>(url: string, params?: any, config?: AxiosRequestConfig) {
+    return await this.instance.get<any, IResponseData<T>>(url, {
+      ...config,
+      params: params,
+    });
+  }
+
+  async delete<T = any>(url: string, params?: any, config?: AxiosRequestConfig) {
+    return await this.instance.delete<any, IResponseData<T>>(url, {
+      ...config,
+      params: params,
+    });
+  }
+
+  async post<T = any>(url: string, data?: any, config?: AxiosRequestConfig) {
+    return await this.instance.post<any, IResponseData<T>>(url, data, config);
+  }
+
+  async put<T = any>(url: string, data?: any, config?: AxiosRequestConfig) {
+    return await this.instance.put<any, IResponseData<T>>(url, data, config);
+  }
+}

package/src/types.ts

@@ -0,0 +1,23 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+
+export type IErrorHandle = (args: IResponseData, response?: AxiosResponse) => void;
+export type IHandleRequest = (config: AxiosRequestConfig) => void;
+
+// 后端返回数据结构
+export interface IResponseData<T = any> {
+  code: number;
+  data: T;
+  msg: string;
+  total: number;
+  trace: string;
+  statusCode?: number; // 老接口兼容
+  message?: string;
+}
+
+// 自定义配置
+export interface ICustomConfig {
+  raw?: boolean; // 是否返回axios 原始数据，不处理handleResponse
+  debugger?: boolean; // 是否开启 debugger 模式
+  errorHandle?: IErrorHandle; // 错误处理函数
+  handleRequest?: IHandleRequest;
+}

package/types/index.d.ts

@@ -0,0 +1,17 @@
+import { AxiosRequestConfig } from 'axios';
+import { IResponseData, ICustomConfig } from './types';
+export default class HttpServer {
+  private instance;
+  private readonly debugger;
+  constructor(options?: AxiosRequestConfig, customOptions?: ICustomConfig);
+  private handleRequest;
+  private handleResponse;
+  get<T = any>(url: string, params?: any, config?: AxiosRequestConfig): Promise<IResponseData<T>>;
+  delete<T = any>(
+    url: string,
+    params?: any,
+    config?: AxiosRequestConfig,
+  ): Promise<IResponseData<T>>;
+  post<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<IResponseData<T>>;
+  put<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<IResponseData<T>>;
+}

package/types/index.js

@@ -0,0 +1,89 @@
+import axios from 'axios';
+const defaultConfig = {
+  baseURL: '',
+  method: 'get',
+  timeout: 1000 * 10,
+  withCredentials: false,
+};
+const defaultCustomConfig = {
+  raw: false,
+  errorHandle: undefined,
+  handleRequest: undefined,
+  debugger: false,
+};
+export default class HttpServer {
+  instance;
+  debugger;
+  constructor(options, customOptions) {
+    const config = Object.assign(defaultConfig, options);
+    const customConfig = Object.assign(defaultCustomConfig, customOptions);
+    this.instance = axios.create(config);
+    this.debugger = customOptions?.debugger;
+    if (customConfig.handleRequest) {
+      this.handleRequest(customConfig.handleRequest);
+    }
+    if (!customConfig.raw && customConfig.errorHandle) {
+      this.handleResponse(customConfig.errorHandle);
+    }
+  }
+  handleRequest(handle) {
+    this.instance.interceptors.request.use(
+      config => {
+        if (this.debugger) {
+          console.log('请求 config 打印', config);
+        }
+        return handle(config);
+      },
+      error => {
+        return Promise.reject(error);
+      },
+    );
+  }
+  handleResponse(errorHandle) {
+    // 响应请求的拦截器
+    this.instance.interceptors.response.use(
+      response => {
+        if (this.debugger) {
+          console.log('请求 response 打印', response);
+        }
+        // 请求 blob 时直接返回数据 ，不做拦截处理
+        if (response.request.responseType === 'blob') return response.data;
+        const data = response.data;
+        const code = data.code || data.statusCode;
+        if (code === 200) return data;
+        errorHandle(data, response);
+        return Promise.reject(data);
+      },
+      error => {
+        const response = {
+          code: +error.message.slice(-3),
+          data: {},
+          msg: error.message,
+          total: 0,
+          trace: '',
+        };
+        errorHandle(response);
+        return Promise.reject(response);
+      },
+    );
+  }
+  async get(url, params, config) {
+    return await this.instance.get(url, {
+      ...config,
+      params: params,
+    });
+  }
+  async delete(url, params, config) {
+    return await this.instance.delete(url, {
+      ...config,
+      params: params,
+    });
+  }
+  async post(url, data, config) {
+    return await this.instance.post(url, data, config);
+  }
+  async put(url, data, config) {
+    return await this.instance.put(url, data, config);
+  }
+}
+//# sourceMappingURL=index.js.map

package/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA4C,MAAM,OAAO,CAAC;AAGjE,MAAM,aAAa,GAAuB;IACxC,OAAO,EAAE,EAAE;IACX,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,IAAI,GAAG,EAAE;IAClB,eAAe,EAAE,KAAK;CACvB,CAAC;AAEF,MAAM,mBAAmB,GAAkB;IACzC,GAAG,EAAE,KAAK;IACV,WAAW,EAAE,SAAS;IACtB,aAAa,EAAE,SAAS;IACxB,QAAQ,EAAE,KAAK;CAChB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,UAAU;IACrB,QAAQ,CAAgB;IACf,QAAQ,CAAsB;IAE/C,YAAY,OAA4B,EAAE,aAA6B;QACrE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QACrD,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;QACvE,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,aAAa,EAAE,QAAQ,CAAC;QAExC,IAAI,YAAY,CAAC,aAAa,EAAE;YAC9B,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;SAChD;QACD,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,YAAY,CAAC,WAAW,EAAE;YACjD,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;SAC/C;IACH,CAAC;IAEO,aAAa,CAAC,MAAsB;QAC1C,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CACpC,MAAM,CAAC,EAAE;YACP,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACjB,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;aACrC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC,EACD,KAAK,CAAC,EAAE;YACN,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,cAAc,CAAC,WAAyB;QAC9C,WAAW;QACX,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CACrC,QAAQ,CAAC,EAAE;YACT,IAAI,IAAI,CAAC,QAAQ,EAAE;gBACjB,OAAO,CAAC,GAAG,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;aACzC;YAED,0BAA0B;YAC1B,IAAI,QAAQ,CAAC,OAAO,CAAC,YAAY,KAAK,MAAM;gBAAE,OAAO,QAAQ,CAAC,IAAI,CAAC;YAEnE,MAAM,IAAI,GAAkB,QAAQ,CAAC,IAAI,CAAC;YAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC;YAC1C,IAAI,IAAI,KAAK,GAAG;gBAAE,OAAO,IAAI,CAAC;YAC9B,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAC5B,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9B,CAAC,EACD,CAAC,KAAY,EAAE,EAAE;YACf,MAAM,QAAQ,GAAkB;gBAC9B,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC9B,IAAI,EAAE,EAAE;gBACR,GAAG,EAAE,KAAK,CAAC,OAAO;gBAClB,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,EAAE;aACV,CAAC;YACF,WAAW,CAAC,QAAQ,CAAC,CAAC;YACtB,OAAO,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClC,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAU,GAAW,EAAE,MAAY,EAAE,MAA2B;QACvE,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,GAAG,EAAE;YACzD,GAAG,MAAM;YACT,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAU,GAAW,EAAE,MAAY,EAAE,MAA2B;QAC1E,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAwB,GAAG,EAAE;YAC5D,GAAG,MAAM;YACT,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,IAAI,CAAU,GAAW,EAAE,IAAU,EAAE,MAA2B;QACtE,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAwB,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED,KAAK,CAAC,GAAG,CAAU,GAAW,EAAE,IAAU,EAAE,MAA2B;QACrE,OAAO,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAwB,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IAC3E,CAAC;CACF"}

package/types/types.d.ts

@@ -0,0 +1,18 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+export declare type IErrorHandle = (args: IResponseData, response?: AxiosResponse) => void;
+export declare type IHandleRequest = (config: AxiosRequestConfig) => void;
+export interface IResponseData<T = any> {
+  code: number;
+  data: T;
+  msg: string;
+  total: number;
+  trace: string;
+  statusCode?: number;
+  message?: string;
+}
+export interface ICustomConfig {
+  raw?: boolean;
+  debugger?: boolean;
+  errorHandle?: IErrorHandle;
+  handleRequest?: IHandleRequest;
+}

package/types/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}