@hzab/data-model 2.0.3-alpha.1 → 2.1.0-alpha.1

package/src/RequestCache.ts

@@ -1,202 +0,0 @@
-import { InternalAxiosRequestConfig } from "axios";
-import { axiosDef } from "./axios";
-
-/**
- * 缓存配置
- */
-export interface CacheOpt {
-  /** 缓存时间 毫秒 */
-  cacheTTL?: number;
-}
-
-/**
- * 缓存方法入参配置
- */
-export interface RequestCacheParams {
-  options?: CacheOpt;
-}
-
-/**
- * 接口入参（用于生成缓存 key）
- */
-export interface Req {
-  method?: string;
-  baseURL?: string;
-  url?: string;
-  params?: unknown;
-  data?: unknown;
-}
-
-/**
- * 缓存对象
- */
-export interface CacheItem {
-  key: string;
-  /** 过期时间戳 */
-  expires?: number;
-  /** 缓存的 promise */
-  promise?: Promise<unknown>;
-  /** 缓存的 axios config 配置 */
-  config?: InternalAxiosRequestConfig;
-  resolve: (d) => void;
-  reject: (err) => void;
-}
-
-/**
- * 接口缓存类
- */
-export class RequestCache {
-  options: CacheOpt;
-  cacheTTL = 3000;
-  /** 存储为 CacheItem（类型为 unknown，返回时断言） */
-  _cacheMap: Map<string, CacheItem> = new Map();
-
-  constructor(params: RequestCacheParams) {
-    const { options = {} } = params || {};
-    this.cacheTTL = options?.cacheTTL ?? 3000;
-    this.options = options;
-  }
-
-  /**
-   * 处理 axios request 拦截逻辑
-   * @param config
-   * @returns
-   */
-  handleAxRequest(config) {
-    if (this.hasCache(config)) {
-      const cache = this.getCache(config);
-      // 存在缓存，
-      return Promise.reject({
-        code: 200,
-        key: this.getCacheKey(config),
-        config,
-        from: "cache",
-        cache,
-      });
-    }
-    this.rmCache(config);
-
-    const cacheData = {
-      code: 200,
-      key: this.getCacheKey(config),
-      config,
-      from: "cache",
-      promise: undefined,
-      resolve: undefined,
-      reject: undefined,
-    };
-    // 设置 promise 保持请求挂起状态
-    cacheData.promise = new Promise((resolve, reject) => {
-      cacheData.resolve = resolve;
-      cacheData.reject = reject;
-    });
-
-    config.cache = this.addCache(cacheData);
-    return config;
-  }
-
-  /**
-   * 判断是否存在缓存
-   * @param axConf
-   * @returns
-   */
-  hasCache(axConf) {
-    const key = this.getCacheKey(axConf);
-    const cache = this._cacheMap.get(key);
-    if (cache && cache.expires >= Date.now()) {
-      return true;
-    }
-    // 过期清除
-    this._cacheMap.delete(key);
-    return false;
-  }
-
-  /**
-   * 获取缓存
-   * @param axios config
-   * @param opt 自定义缓存配置
-   * @returns Promise<T>
-   */
-  getCache(axConf, opt?: CacheOpt): CacheItem {
-    const key = this.getCacheKey(axConf);
-
-    return this.getCacheByKey(key, opt);
-  }
-
-  /**
-   * 获取缓存
-   * @param key string
-   * @param opt 自定义缓存配置
-   * @returns Promise<T>
-   */
-  getCacheByKey(key, opt?: CacheOpt) {
-    // TODO: 过期处理？ 结果和请求分开。只有请求才进行过期判断？
-    // 存在未过期的缓存
-    const cached = this._cacheMap.get(key);
-    if (cached && cached.expires > Date.now()) {
-      return cached;
-    }
-
-    // 过期删除
-    if (cached) {
-      this._cacheMap.delete(key);
-    }
-  }
-
-  /**
-   * 添加缓存
-   * @param promise 要缓存的 Promise
-   * @param req 请求描述对象
-   * @param config 缓存配置
-   */
-  addCache(data: CacheItem, opt: CacheOpt = this.options): CacheItem {
-    const { config } = data || {};
-    const key = this.getCacheKey(config);
-    if (this._cacheMap.has(key)) {
-      return this._cacheMap.get(key);
-    }
-    const ttl = opt?.cacheTTL ?? this.cacheTTL;
-    const cache = {
-      ...data,
-      key,
-      expires: Date.now() + ttl,
-      config: config,
-      promise: data.promise,
-    };
-    this._cacheMap.set(key, cache);
-    return cache;
-  }
-
-  rmCache(config: Req) {
-    this._cacheMap.delete(this.getCacheKey(config));
-  }
-
-  /**
-   * 获取缓存的 key
-   * @param config 请求入参
-   * @returns 缓存键字符串
-   */
-  getCacheKey(config: Req): string {
-    const { baseURL, method, url, params, data } = config;
-    // 注意：params 和 data 需要序列化，并保证对象属性顺序稳定性
-    return `${method}:${baseURL}/${url}:${this.stableStringify(params)}:${this.stableStringify(data)}`;
-  }
-
-  /**
-   * 序列化对象，保证属性顺序一致
-   * @param obj 任意值
-   * @returns JSON 字符串
-   */
-  private stableStringify(obj: unknown): string {
-    if (!obj || typeof obj !== "object") return JSON.stringify(obj);
-    const sorted = Object.keys(obj)
-      .sort()
-      .reduce((acc, key) => {
-        acc[key] = (obj as Record<string, unknown>)[key];
-        return acc;
-      }, {} as Record<string, unknown>);
-    return JSON.stringify(sorted);
-  }
-}
-
-export default RequestCache;

package/src/array-data-model.ts

@@ -1,479 +0,0 @@
-import { merge, pickBy, isNil, cloneDeep } from "lodash-es";
-
-import ArrayUtils, { STATE_CODE, FindListResult, ArrayUtilsOptions } from "./ArrayUtils";
-
-import { JSONObject, QueryParams, RequestData, MapFunction, RequestMapFunction, GetListFunc } from "./type";
-
-const errMsg: Record<number | string, string> = {
-  404: "未找到对应子项",
-  501: "未传入表单 id",
-};
-
-/**
- * ArrayDataModel 构造函数参数接口
- */
-export interface ArrayDataModelOptions<R = any> extends ArrayUtilsOptions<R> {
-  /** 请求 url 替换的额外参数 */
-  ctx?: JSONObject;
-  /** GET 请求的参数 */
-  query?: QueryParams;
-
-  /** POST 接口地址 */
-  createApi?: string;
-  /** POST 接口提交前的数据处理回调 */
-  createMap?: MapFunction;
-  /** GET 详情 接口地址 */
-  getApi?: string;
-  /** GET 详情 接口返回后的数据处理回调 */
-  getMap?: MapFunction;
-  /** GET 列表 接口地址 */
-  getListApi?: string;
-  /** GET 列表 接口返回后的数据处理回调 */
-  getListMap?: MapFunction;
-  /** GET 列表 接口回调，用于自定义列表请求接口 */
-  getListFunc?: GetListFunc<R>;
-  /** PUT 接口地址 */
-  updateApi?: string;
-  /** PUT 接口提交前的数据处理回调 */
-  updateMap?: MapFunction;
-  /** PATCH 接口地址 */
-  patchApi?: string;
-  /** PATCH 接口提交前的数据处理回调 */
-  patchMap?: MapFunction;
-  /** DELETE 接口地址 */
-  deleteApi?: string;
-  /** DELETE 批量删除 接口地址 */
-  multipleDeleteApi?: string;
-
-  /** GET 列表 接口请求前数据处理回调 */
-  getListReqMap?: RequestMapFunction<QueryParams>;
-  /** GET 列表 接口请求结果数据处理回调 */
-  getListResMap?: MapFunction;
-  /** GET 详情 接口请求前数据处理回调 */
-  getReqMap?: RequestMapFunction<QueryParams>;
-  /** GET 详情 接口请求结果数据处理回调 */
-  getResMap?: MapFunction;
-  /** POST 接口请求前数据处理回调 */
-  createReqMap?: RequestMapFunction<RequestData>;
-  /** POST 接口请求结果数据处理回调 */
-  createResMap?: MapFunction;
-  /** PUT 接口请求前数据处理回调 */
-  updateReqMap?: RequestMapFunction<RequestData>;
-  /** PUT 接口请求结果数据处理回调 */
-  updateResMap?: MapFunction;
-  /** PATCH 接口请求前数据处理回调 */
-  patchReqMap?: RequestMapFunction<RequestData>;
-  /** PATCH 接口请求结果数据处理回调 */
-  patchResMap?: MapFunction;
-  /** DELETE 接口请求前数据处理回调 */
-  deleteReqMap?: RequestMapFunction<JSONObject>;
-  /** DELETE 接口请求结果数据处理回调 */
-  deleteResMap?: MapFunction;
-  /** DELETE 批量删除 接口请求前数据处理回调 */
-  multipleDeleteReqMap?: RequestMapFunction<JSONObject>;
-  /** DELETE 批量删除 接口请求结果数据处理回调 */
-  multipleDeleteResMap?: MapFunction;
-
-  /** 查询选项 */
-  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: QueryParams;
-
-  /** POST 接口地址 */
-  createApi?: string;
-  /** POST 接口提交前的数据处理回调 */
-  createMap?: MapFunction;
-  /** GET 详情 接口地址 */
-  getApi?: string;
-  /** GET 详情 接口返回后的数据处理回调 */
-  getMap?: MapFunction;
-  /** GET 列表 接口地址 */
-  getListApi?: string;
-  /** GET 列表 接口返回后的数据处理回调 */
-  getListMap?: MapFunction;
-  /** GET 列表 接口回调，用于自定义列表请求接口 */
-  getListFunc?: GetListFunc<T>;
-  /** PUT 接口地址 */
-  updateApi?: string;
-  /** PUT 接口提交前的数据处理回调 */
-  updateMap?: MapFunction;
-  /** PATCH 接口地址 */
-  patchApi?: string;
-  /** PATCH 接口提交前的数据处理回调 */
-  patchMap?: MapFunction;
-  /** DELETE 接口地址 */
-  deleteApi?: string;
-  /** DELETE 批量删除 接口地址 */
-  multipleDeleteApi?: string;
-
-  /** GET 列表 接口请求前数据处理回调 */
-  getListReqMap?: RequestMapFunction<QueryParams>;
-  /** GET 列表 接口请求结果数据处理回调 */
-  getListResMap?: MapFunction;
-  /** GET 详情 接口请求前数据处理回调 */
-  getReqMap?: RequestMapFunction<QueryParams>;
-  /** GET 详情 接口请求结果数据处理回调 */
-  getResMap?: MapFunction;
-  /** POST 接口请求前数据处理回调 */
-  createReqMap?: RequestMapFunction<RequestData>;
-  /** POST 接口请求结果数据处理回调 */
-  createResMap?: MapFunction;
-  /** PUT 接口请求前数据处理回调 */
-  updateReqMap?: RequestMapFunction<RequestData>;
-  /** PUT 接口请求结果数据处理回调 */
-  updateResMap?: MapFunction;
-  /** PATCH 接口请求前数据处理回调 */
-  patchReqMap?: RequestMapFunction<RequestData>;
-  /** PATCH 接口请求结果数据处理回调 */
-  patchResMap?: MapFunction;
-  /** DELETE 接口请求前数据处理回调 */
-  deleteReqMap?: RequestMapFunction<JSONObject>;
-  /** DELETE 接口请求结果数据处理回调 */
-  deleteResMap?: MapFunction;
-  /** DELETE 批量删除 接口请求前数据处理回调 */
-  multipleDeleteReqMap?: RequestMapFunction<JSONObject>;
-  /** DELETE 批量删除 接口请求结果数据处理回调 */
-  multipleDeleteResMap?: MapFunction;
-
-  /** 查询选项 */
-  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>
-   */
-  async get(q: QueryParams = {}): Promise<T> {
-    let query = merge({}, this.query, q);
-    query = pickBy(query, (val) => !isNil(val) && val !== "");
-
-    if (this.getReqMap) {
-      query = await 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: QueryParams = {}): Promise<FindListResult<T>> {
-    let query = merge({}, this.query, q);
-    query = pickBy(query, (val) => !isNil(val) && val !== "");
-
-    if (this.getListReqMap) {
-      query = await 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: RequestData | FormData): Promise<Record<string, any>> {
-    return new Promise(async (resolve, reject) => {
-      const _params = await this.handleInputParams(params, this.createReqMap);
-      const res = this.pushItem(_params);
-      this.handleRes(res, resolve, reject, { resMap: this.createResMap });
-    });
-  }
-
-  /**
-   * PUT 请求
-   * @param params 参数
-   * @returns Promise<Record<string, any>>
-   */
-  update(params: RequestData | FormData): Promise<Record<string, any>> {
-    return new Promise(async (resolve, reject) => {
-      const _params = await this.handleInputParams(params, this.updateReqMap);
-      const res = this.replaceItem(_params as T);
-      this.handleRes(res, resolve, reject, { resMap: this.updateResMap });
-    });
-  }
-
-  /**
-   * PATCH 请求
-   * @param params 参数
-   * @returns Promise<Record<string, any>>
-   */
-  patch(params: RequestData | FormData): Promise<Record<string, any>> {
-    return new Promise(async (resolve, reject) => {
-      const _params = await this.handleInputParams(params, this.patchReqMap);
-      const res = this.updateItemValue(_params);
-      this.handleRes(res, resolve, reject, { resMap: this.patchResMap });
-    });
-  }
-
-  /**
-   * 删除接口
-   * @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);
-      this.handleRes(res, resolve, reject, { resMap: this.deleteResMap });
-    });
-  }
-
-  /**
-   * 批量删除接口
-   * @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 处理后的参数
-   */
-  async handleInputParams(
-    params: any,
-    reqMapFn?: (params: Record<string, any>, originalParams?: any) => Record<string, any>,
-  ): Promise<Partial<T> & Record<string, any>> {
-    let _params = cloneDeep(params) as Partial<T> & Record<string, any>;
-    if (reqMapFn) {
-      _params = (await reqMapFn(_params, params)) as Partial<T> & Record<string, any>;
-    }
-    // TODO: FormData 文件存储？
-    // if (params instanceof FormData) {
-    //   _params = objToFormData(_params);
-    // }
-    return _params;
-  }
-
-  /**
-   * 处理响应结果
-   * @param response 响应对象
-   * @param resolve 成功回调
-   * @param reject 失败回调
-   */
-  handleRes(res: any, resolve: (res: any) => void, reject: (err: any) => void, opt?): void {
-    const { resMap } = opt || {};
-    if (res === STATE_CODE.SUC) {
-      let _res: Record<string, any> = {};
-      if (resMap) {
-        _res = resMap(_res);
-      }
-      resolve(_res);
-    } else {
-      reject({
-        code: res,
-        _message: errMsg[res] || "未知错误",
-        _msg: errMsg[res] || "未知错误",
-      });
-    }
-  }
-}
-
-export { ArrayDataModel };
-
-export default ArrayDataModel;