@hzab/data-model 1.8.9-alpha.0 → 2.0.0-alpha.0

package/src/array-data-model.ts

@@ -0,0 +1,583 @@
+import { merge, pickBy, isNil, cloneDeep, isObject } from "lodash";
+
+import { _$Temp } from "./utils";
+import ArrayUtils, { STATE_CODE, FindListResult, ItemQuery, ArrayUtilsOptions } from "./ArrayUtils";
+
+const errMsg: Record<number | string, string> = {
+  404: "未找到对应子项",
+  501: "未传入表单 id",
+};
+
+/**
+ * ArrayDataModel 构造函数参数接口
+ */
+export interface ArrayDataModelOptions<T = any> extends ArrayUtilsOptions<T> {
+  /** 请求 url 替换的额外参数 */
+  ctx?: Record<string, any>;
+  /** GET 请求的参数 */
+  query?: Record<string, any>;
+
+  /** POST 接口地址 */
+  createApi?: string;
+  /** POST 接口提交前的数据处理回调 */
+  createMap?: (record: T) => T;
+  /** GET 详情 接口地址 */
+  getApi?: string;
+  /** GET 详情 接口返回后的数据处理回调 */
+  getMap?: (record: T) => T;
+  /** GET 列表 接口地址 */
+  getListApi?: string;
+  /** GET 列表 接口返回后的数据处理回调 */
+  getListMap?: (record: T) => T;
+  /** GET 列表 接口回调，用于自定义列表请求接口 */
+  getListFunc?: (query: Record<string, any>) => Promise<FindListResult<T>>;
+  /** PUT 接口地址 */
+  updateApi?: string;
+  /** PUT 接口提交前的数据处理回调 */
+  updateMap?: (record: T) => T;
+  /** PATCH 接口地址 */
+  patchApi?: string;
+  /** PATCH 接口提交前的数据处理回调 */
+  patchMap?: (record: T) => T;
+  /** DELETE 接口地址 */
+  deleteApi?: string;
+  /** DELETE 批量删除 接口地址 */
+  multipleDeleteApi?: string;
+
+  /** GET 列表 接口请求前数据处理回调 */
+  getListReqMap?: (params: Record<string, any>) => Record<string, any>;
+  /** GET 列表 接口请求结果数据处理回调 */
+  getListResMap?: (result: FindListResult<T>) => FindListResult<T>;
+  /** GET 详情 接口请求前数据处理回调 */
+  getReqMap?: (params: Record<string, any>) => Record<string, any>;
+  /** GET 详情 接口请求结果数据处理回调 */
+  getResMap?: (record: T) => T;
+  /** POST 接口请求前数据处理回调 */
+  createReqMap?: (params: Record<string, any>, originalParams?: any) => Record<string, any>;
+  /** POST 接口请求结果数据处理回调 */
+  createResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** PUT 接口请求前数据处理回调 */
+  updateReqMap?: (params: Record<string, any>, originalParams?: any) => Record<string, any>;
+  /** PUT 接口请求结果数据处理回调 */
+  updateResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** PATCH 接口请求前数据处理回调 */
+  patchReqMap?: (params: Record<string, any>, originalParams?: any) => Record<string, any>;
+  /** PATCH 接口请求结果数据处理回调 */
+  patchResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** DELETE 接口请求前数据处理回调 */
+  deleteReqMap?: (config: Record<string, any>) => Record<string, any>;
+  /** DELETE 接口请求结果数据处理回调 */
+  deleteResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** DELETE 批量删除 接口请求前数据处理回调 */
+  multipleDeleteReqMap?: (config: Record<string, any>) => Record<string, any>;
+  /** DELETE 批量删除 接口请求结果数据处理回调 */
+  multipleDeleteResMap?: (data: { sucList: any[]; failList: any[] }) => { sucList: any[]; failList: any[] };
+
+  /** 查询选项 */
+  arrOptions?: ArrOptions;
+}
+
+/**
+ * 查询选项
+ */
+export interface ArrOptions {
+  /** 字符串字段是否开启模糊匹配 */
+  fuzzy?: boolean;
+  /** 模糊匹配时是否忽略大小写 */
+  ignoreCase?: boolean;
+}
+
+/**
+ * 删除请求配置接口
+ */
+export interface ArrayDeleteConfig {
+  /** axios delete url 参数 */
+  params?: Record<string, any>;
+  /** axios delete data 参数 */
+  data?: Record<string, any>;
+  /** 其他 axios delete 配置 */
+  [key: string]: any;
+}
+
+/**
+ * 错误处理选项接口
+ */
+export interface HandleMsgOptions {
+  /** 是否使用 response.statusText 作为兜底 msg */
+  useStatusText?: boolean;
+}
+
+/**
+ * 批量删除结果接口
+ */
+export interface MultipleDeleteResult {
+  /** 成功删除的 ID 列表 */
+  sucList: any[];
+  /** 失败删除的 ID 列表 */
+  failList: any[];
+}
+
+/**
+ * ArrayDataModel 本地数据 DataModel
+ * @template T - 数据类型
+ */
+class ArrayDataModel<T = any> extends ArrayUtils<T> {
+  /** 请求 url 替换的额外参数 */
+  ctx: Record<string, any>;
+  /** GET 请求的参数 */
+  query: Record<string, any>;
+
+  /** POST 接口地址 */
+  createApi?: string;
+  /** POST 接口提交前的数据处理回调 */
+  createMap?: (record: T) => T;
+  /** GET 详情 接口地址 */
+  getApi?: string;
+  /** GET 详情 接口返回后的数据处理回调 */
+  getMap?: (record: T) => T;
+  /** GET 列表 接口地址 */
+  getListApi?: string;
+  /** GET 列表 接口返回后的数据处理回调 */
+  getListMap?: (record: T) => T;
+  /** GET 列表 接口回调，用于自定义列表请求接口。query => ({list: [], pagination: { total: 0 }}) 优先级高于 getListApi */
+  getListFunc?: (query: Record<string, any>) => Promise<FindListResult<T>>;
+  /** PUT 接口地址 */
+  updateApi?: string;
+  /** PUT 接口提交前的数据处理回调 */
+  updateMap?: (record: T) => T;
+  /** PATCH 接口地址 */
+  patchApi?: string;
+  /** PATCH 接口提交前的数据处理回调 */
+  patchMap?: (record: T) => T;
+  /** DELETE 接口地址 */
+  deleteApi?: string;
+  /** DELETE 批量删除 接口地址 */
+  multipleDeleteApi?: string;
+
+  /** GET 列表 接口请求前数据处理回调 */
+  getListReqMap?: (params: Record<string, any>) => Record<string, any>;
+  /** GET 列表 接口请求结果数据处理回调 */
+  getListResMap?: (result: FindListResult<T>) => FindListResult<T>;
+  /** GET 详情 接口请求前数据处理回调 */
+  getReqMap?: (params: Record<string, any>) => Record<string, any>;
+  /** GET 详情 接口请求结果数据处理回调 */
+  getResMap?: (record: T) => T;
+  /** POST 接口请求前数据处理回调 */
+  createReqMap?: (params: Record<string, any>, originalParams?: any) => Record<string, any>;
+  /** POST 接口请求结果数据处理回调 */
+  createResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** PUT 接口请求前数据处理回调 */
+  updateReqMap?: (params: Record<string, any>, originalParams?: any) => Record<string, any>;
+  /** PUT 接口请求结果数据处理回调 */
+  updateResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** PATCH 接口请求前数据处理回调 */
+  patchReqMap?: (params: Record<string, any>, originalParams?: any) => Record<string, any>;
+  /** PATCH 接口请求结果数据处理回调 */
+  patchResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** DELETE 接口请求前数据处理回调 */
+  deleteReqMap?: (config: Record<string, any>) => Record<string, any>;
+  /** DELETE 接口请求结果数据处理回调 */
+  deleteResMap?: (data: Record<string, any>) => Record<string, any>;
+  /** DELETE 批量删除 接口请求前数据处理回调 */
+  multipleDeleteReqMap?: (config: Record<string, any>) => Record<string, any>;
+  /** DELETE 批量删除 接口请求结果数据处理回调 */
+  multipleDeleteResMap?: (data: MultipleDeleteResult) => MultipleDeleteResult;
+
+  /** 查询选项 */
+  private _arrOptions?: ArrOptions;
+
+  constructor(params: ArrayDataModelOptions<T> = {} as ArrayDataModelOptions<T>) {
+    super(params);
+    const {
+      ctx,
+      query,
+      createApi,
+      createMap,
+      getApi,
+      getMap,
+      getListApi,
+      getListMap,
+      getListFunc,
+      updateApi,
+      updateMap,
+      patchApi,
+      patchMap,
+      deleteApi,
+      multipleDeleteApi,
+    } = params;
+
+    this.ctx = ctx || {};
+    this.query = query || {};
+
+    this.createApi = createApi;
+    this.createMap = createMap;
+    this.getApi = getApi;
+    this.getMap = getMap;
+    this.getListApi = getListApi;
+    this.getListMap = getListMap;
+    this.getListFunc = getListFunc;
+    this.updateApi = updateApi;
+    this.updateMap = updateMap;
+    this.patchApi = patchApi;
+    this.patchMap = patchMap;
+    this.deleteApi = deleteApi;
+    this.multipleDeleteApi = multipleDeleteApi;
+
+    const {
+      getListReqMap,
+      getListResMap,
+      getReqMap,
+      getResMap,
+      createReqMap,
+      createResMap,
+      updateReqMap,
+      updateResMap,
+      patchReqMap,
+      patchResMap,
+      deleteReqMap,
+      deleteResMap,
+      multipleDeleteReqMap,
+      multipleDeleteResMap,
+      arrOptions,
+    } = params || {};
+
+    this.getListReqMap = getListReqMap;
+    this.getListResMap = getListResMap;
+    this.getReqMap = getReqMap;
+    this.getResMap = getResMap;
+    this.createReqMap = createReqMap;
+    this.createResMap = createResMap;
+    this.updateReqMap = updateReqMap;
+    this.updateResMap = updateResMap;
+    this.patchReqMap = patchReqMap;
+    this.patchResMap = patchResMap;
+    this.deleteReqMap = deleteReqMap;
+    this.deleteResMap = deleteResMap;
+    this.multipleDeleteReqMap = multipleDeleteReqMap;
+    this.multipleDeleteResMap = multipleDeleteResMap;
+    this._arrOptions = arrOptions;
+  }
+
+  /**
+   * GET 详情请求
+   * @param q query 参数
+   * @returns Promise<T>
+   */
+  get(q: Record<string, any> = {}): Promise<T | null> {
+    let query = merge({}, this.query, q);
+    query = pickBy(query, (val) => !isNil(val) && val !== "");
+
+    if (this.getReqMap) {
+      query = this.getReqMap(query);
+    }
+
+    return new Promise((resolve) => {
+      let res = this.findItem(query, this._arrOptions);
+      if (res && this.getMap) {
+        res = this.getMap(res);
+      }
+      if (res && this.getResMap) {
+        res = this.getResMap(res);
+      }
+      resolve(res);
+    });
+  }
+
+  /**
+   * GET 列表请求
+   * @param q query 参数
+   * @returns Promise<FindListResult<T>>
+   */
+  async getList(q: Record<string, any> = {}): Promise<FindListResult<T>> {
+    let query = merge({}, this.query, q);
+    query = pickBy(query, (val) => !isNil(val) && val !== "");
+
+    if (this.getListReqMap) {
+      query = this.getListReqMap(query);
+    }
+
+    let resultList: FindListResult<T>;
+    if (this.getListFunc) {
+      resultList = await this.getListFunc(query);
+    } else {
+      resultList = await this.findListByQuery(query, this._arrOptions);
+    }
+
+    const getListMap = this.getListMap;
+    if (getListMap) {
+      resultList.list = resultList?.list?.map((record) => getListMap(record));
+    }
+
+    const getListResMap = this.getListResMap;
+    if (getListResMap) {
+      resultList = getListResMap(resultList);
+    }
+
+    return resultList;
+  }
+
+  /**
+   * POST 请求
+   * @param params 参数
+   * @returns Promise<Record<string, any>>
+   */
+  create(params: Record<string, any> | FormData): Promise<Record<string, any>> {
+    return new Promise((resolve, reject) => {
+      const _params = this.handleInputParams(params, this.createReqMap);
+      const res = this.pushItem(_params);
+      if (res === STATE_CODE.SUC) {
+        let _res: Record<string, any> = {};
+        if (this.createResMap) {
+          _res = this.createResMap(_res);
+        }
+        resolve(_res);
+      } else {
+        reject({
+          code: res,
+          _message: errMsg[res] || "未知错误",
+        });
+      }
+    });
+  }
+
+  /**
+   * PUT 请求
+   * @param params 参数
+   * @returns Promise<Record<string, any>>
+   */
+  update(params: Record<string, any> | FormData): Promise<Record<string, any>> {
+    return new Promise((resolve, reject) => {
+      const _params = this.handleInputParams(params, this.updateReqMap);
+      const res = this.replaceItem(_params as T);
+      if (res === STATE_CODE.SUC) {
+        let _res: Record<string, any> = {};
+        if (this.updateResMap) {
+          _res = this.updateResMap(_res);
+        }
+        resolve(_res);
+      } else {
+        reject({
+          code: res,
+          _message: errMsg[res] || "未知错误",
+        });
+      }
+    });
+  }
+
+  /**
+   * PATCH 请求
+   * @param params 参数
+   * @returns Promise<Record<string, any>>
+   */
+  patch(params: Record<string, any> | FormData): Promise<Record<string, any>> {
+    return new Promise((resolve, reject) => {
+      const _params = this.handleInputParams(params, this.patchReqMap);
+      const res = this.updateItemValue(_params);
+      if (res === STATE_CODE.SUC) {
+        let _res: Record<string, any> = {};
+        if (this.patchResMap) {
+          _res = this.patchResMap(_res);
+        }
+        resolve(_res);
+      } else {
+        reject({
+          code: res,
+          _message: errMsg[res] || "未知错误",
+        });
+      }
+    });
+  }
+
+  /**
+   * 删除接口
+   * @param config axios.delete config 参数
+   * @param config.params axios.delete url 参数
+   * @param config.data axios.delete data 参数
+   * @param ctx url 替换的额外参数
+   * @returns Promise<Record<string, any>>
+   */
+  delete(config?: ArrayDeleteConfig, ctx?: Record<string, any>): Promise<Record<string, any>> {
+    let _config = cloneDeep(config) || {};
+    if (this.deleteReqMap) {
+      _config = this.deleteReqMap(_config);
+    }
+    return new Promise((resolve, reject) => {
+      const { _idKey } = this;
+      const id = (config as any)?.[_idKey] || config?.params?.[_idKey] || config?.data?.[_idKey] || ctx?.[_idKey];
+      const res = this.delItem(id);
+      if (res === STATE_CODE.SUC) {
+        let _res: Record<string, any> = {};
+        if (this.deleteResMap) {
+          _res = this.deleteResMap(_res);
+        }
+        resolve(_res);
+      } else {
+        reject({
+          code: res,
+          _message: errMsg[res] || "未知错误",
+        });
+      }
+    });
+  }
+
+  /**
+   * 批量删除接口
+   * @param config axios.delete config 参数
+   * @param config.params axios.delete url 参数
+   * @param config.data axios.delete data 参数
+   * @param ctx url 替换的额外参数
+   * @returns Promise<MultipleDeleteResult>
+   */
+  multipleDelete(config?: ArrayDeleteConfig, ctx?: Record<string, any>): Promise<MultipleDeleteResult> {
+    let _config = cloneDeep(config) || {};
+    if (this.multipleDeleteReqMap) {
+      _config = this.multipleDeleteReqMap(_config);
+    }
+    return new Promise((resolve, reject) => {
+      const { _idKey } = this;
+      let ids = (config as any)?.[_idKey] || config?.params?.[_idKey] || config?.data?.[_idKey] || ctx?.[_idKey];
+
+      if (typeof ids === "string") {
+        ids = ids.split(",");
+      }
+
+      if (Array.isArray(ids)) {
+        const sucList: any[] = [];
+        const failList: any[] = [];
+        ids.forEach((id: any) => {
+          try {
+            const res = this.delItem(id);
+            if (res === STATE_CODE.SUC) {
+              sucList.push(id);
+            } else {
+              failList.push(id);
+            }
+          } catch (error) {
+            console.log("error", error);
+          }
+        });
+        if (sucList.length > 0) {
+          let _res: MultipleDeleteResult = { sucList, failList };
+          if (this.multipleDeleteResMap) {
+            _res = this.multipleDeleteResMap(_res);
+          }
+          resolve(_res);
+        } else {
+          reject({ failList });
+        }
+        return;
+      }
+
+      reject({});
+    });
+  }
+
+  /**
+   * 处理传入的数据
+   * @param params 参数
+   * @param reqMapFn 请求前处理函数
+   * @returns 处理后的参数
+   */
+  handleInputParams(
+    params: any,
+    reqMapFn?: (params: Record<string, any>, originalParams?: any) => Record<string, any>,
+  ): Record<string, any> {
+    let _params = cloneDeep(params);
+    if (reqMapFn) {
+      _params = reqMapFn.bind(this)(_params, params);
+    }
+    // TODO: FormData 文件存储？
+    // if (params instanceof FormData) {
+    //   _params = objToFormData(_params);
+    // }
+    return _params;
+  }
+
+  /**
+   * 处理响应结果
+   * @param response 响应对象
+   * @param resolve 成功回调
+   * @param reject 失败回调
+   */
+  handleRes(response: any, resolve: (res: any) => void, reject: (err: any) => void): void {
+    if (typeof response !== "object") {
+      reject(new Error("response not object"));
+      return;
+    }
+    let _res = response;
+    // 兼容 传入的是 response.data 的情况
+    if (_res.data && _res.headers && _res.request) {
+      _res = _res.data;
+    }
+    const { code, data } = _res;
+    const message = this.handleMsg(response);
+    if (code == 200) {
+      const _data = data ?? {};
+      if (isObject(_data)) {
+        if (_data.content && _data.pageNumber && _data.total) {
+          _data.list = _data.content;
+          _data.pagination = { current: _data.pageNumber, total: _data.total };
+        }
+        // 前缀 _ 避免与 data 里已有的 message 冲突
+        _data._msg = message;
+        _data._message = message;
+      }
+      resolve(_data);
+    } else {
+      const error = new Error(message);
+      (error as any).code = code;
+      (error as any).response = response;
+      (error as any)._msg = message;
+      (error as any)._message = message;
+      reject(error);
+    }
+  }
+
+  /**
+   * 错误处理器
+   * @param err 错误对象
+   * @param reject Promise reject 回调
+   */
+  errorHandler(err: any = {}, reject: (err: any) => void): void {
+    const response = err.response || err;
+    if (response) {
+      const message = this.handleMsg(response, { useStatusText: true });
+      const error = new Error(message);
+      (error as any).code = response.status;
+      (error as any).response = response;
+      if (message) {
+        // 前缀 _ 避免与 data 里已有的 message 冲突
+        (error as any)._message = message;
+        (error as any)._msg = message;
+      }
+      reject(error);
+      return;
+    }
+    reject(err || { _msg: _$Temp.defaultErrMsg });
+  }
+
+  /**
+   * 处理错误消息
+   * @param response 响应对象
+   * @param opt 选项
+   * @returns 错误消息
+   */
+  handleMsg(
+    response: any,
+    opt: HandleMsgOptions = {
+      useStatusText: false,
+    },
+  ): string {
+    const { useStatusText } = opt || {};
+    let message = (response.data && (response.data.message || response.data.msg)) || response.msg || response.message;
+    if (!message && useStatusText) {
+      message = response.statusText;
+    }
+
+    return message || _$Temp.defaultErrMsg;
+  }
+}
+
+export { ArrayDataModel };
+
+export default ArrayDataModel;