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

package/src/RequestCache.ts

@@ -1,202 +1,202 @@
-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;
+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,4 +1,4 @@
-import { merge, pickBy, isNil, cloneDeep } from "lodash";
+import { merge, pickBy, isNil, cloneDeep } from "lodash-es";
 
 import ArrayUtils, { STATE_CODE, FindListResult, ArrayUtilsOptions } from "./ArrayUtils";
 

package/src/axios.ts

@@ -1,6 +1,6 @@
 import axiosDef, { AxiosResponse, InternalAxiosRequestConfig } from "axios";
 import Cookies from "js-cookie";
-import _ from "lodash";
+import { merge } from "lodash-es";
 
 import { CacheItem } from "./RequestCache";
 
@@ -55,7 +55,7 @@ export function setToken(token = "", opt?: SetTokenOptions) {
   const _t = token || "";
   if (hasCookie) {
     const { cookieAttrs } = opt || {};
-    const cookieOpt = _.merge(
+    const cookieOpt = merge(
       {
         expires: 365,
       },

package/src/data-model.ts

@@ -1,4 +1,4 @@
-import _ from "lodash";
+import { merge, each, isString, isNumber, isBoolean, pickBy, isNil, cloneDeep, isObject } from "lodash-es";
 
 import { axios, isCancel } from "./axios";
 
@@ -407,9 +407,9 @@ class DataModel<T = any, R = Record<string, any>> {
       throw new Error(errMsg);
     }
     let apiUrl = api;
-    const params = _.merge({}, record, ctx);
-    _.each(params, (value, key) => {
-      if (!_.isString(value) || !_.isNumber(value) || _.isBoolean(value)) {
+    const params = merge({}, record, ctx);
+    each(params, (value, key) => {
+      if (!isString(value) || !isNumber(value) || isBoolean(value)) {
         apiUrl = apiUrl.replace(new RegExp(`:${key}$|:${key}(?=/)`), value);
       }
     });
@@ -424,8 +424,8 @@ class DataModel<T = any, R = Record<string, any>> {
    * @returns Promise<any>
    */
   async get(q: QueryParams = {}, ctx: JSONObject = {}, axiosConf?: AxiosConfig): Promise<any> {
-    let query = _.merge({}, this.query, q);
-    query = _.pickBy(query, (val) => !_.isNil(val) && val !== "");
+    let query = merge({}, this.query, q);
+    query = pickBy(query, (val) => !isNil(val) && val !== "");
 
     if (this.getReqMap) {
       query = await this.getReqMap(query);
@@ -467,8 +467,8 @@ class DataModel<T = any, R = Record<string, any>> {
    * @returns Promise<GetListResult<T>>
    */
   async getList(q: QueryParams = {}, ctx: JSONObject = {}, axiosConf?: AxiosConfig): Promise<GetListResult<T>> {
-    let query = _.merge({}, this.query, q);
-    query = _.pickBy(query, (val) => !_.isNil(val) && val !== "");
+    let query = merge({}, this.query, q);
+    query = pickBy(query, (val) => !isNil(val) && val !== "");
 
     if (this.getListReqMap) {
       query = await this.getListReqMap(query);
@@ -525,7 +525,7 @@ class DataModel<T = any, R = Record<string, any>> {
         ...this.createAxiosConf,
         ...axiosConf,
       };
-      let _params = _.cloneDeep(formDataToObj(params));
+      let _params = cloneDeep(formDataToObj(params));
       if (this.createReqMap) {
         _params = await this.createReqMap(_params, params);
       }
@@ -562,7 +562,7 @@ class DataModel<T = any, R = Record<string, any>> {
   update(params?: RequestData | FormData, ctx?: JSONObject, axiosConf?: AxiosConfig): Promise<any> {
     return new Promise(async (resolve, reject) => {
       const opt: AxiosConfig = { ...this.axiosConf, ...this.updateAxiosConf, ...axiosConf };
-      let _params = _.cloneDeep(formDataToObj(params));
+      let _params = cloneDeep(formDataToObj(params));
       if (this.updateReqMap) {
         _params = await this.updateReqMap(_params, params);
       }
@@ -599,7 +599,7 @@ class DataModel<T = any, R = Record<string, any>> {
   patch(params?: RequestData | FormData, ctx?: JSONObject, axiosConf?: AxiosConfig): Promise<any> {
     return new Promise(async (resolve, reject) => {
       const opt: AxiosConfig = { ...this.axiosConf, ...this.patchAxiosConf, ...axiosConf };
-      let _params = _.cloneDeep(formDataToObj(params));
+      let _params = cloneDeep(formDataToObj(params));
       if (this.patchReqMap) {
         _params = await this.patchReqMap(_params, params);
       }
@@ -635,14 +635,14 @@ class DataModel<T = any, R = Record<string, any>> {
    * @returns Promise<any>
    */
   async delete(config?: DeleteConfig, ctx?: JSONObject): Promise<any> {
-    let _config = _.cloneDeep(config) || {};
+    let _config = cloneDeep(config) || {};
     if (this.deleteReqMap) {
       _config = await this.deleteReqMap(_config);
     }
     return new Promise((resolve, reject) => {
       const apiUrl = this.getApiUrl(
         this.deleteApi,
-        Object.assign(_.cloneDeep(_config), _config.params, _config.data),
+        Object.assign(cloneDeep(_config), _config.params, _config.data),
         ctx,
         { from: "delete" },
       );
@@ -673,14 +673,14 @@ class DataModel<T = any, R = Record<string, any>> {
    * @returns Promise<any>
    */
   async multipleDelete(config?: DeleteConfig, ctx?: JSONObject): Promise<any> {
-    let _config = _.cloneDeep(config) || {};
+    let _config = cloneDeep(config) || {};
     if (this.multipleDeleteReqMap) {
       _config = await this.multipleDeleteReqMap(_config);
     }
     return new Promise((resolve, reject) => {
       const apiUrl = this.getApiUrl(
         this.multipleDeleteApi,
-        Object.assign(_.cloneDeep(_config), _config.params, _config.data),
+        Object.assign(cloneDeep(_config), _config.params, _config.data),
         ctx,
         { from: "multipleDelete" },
       );
@@ -741,7 +741,7 @@ class DataModel<T = any, R = Record<string, any>> {
     const message = this.handleMsg(response);
     if (code == 200) {
       const _data = data ?? {};
-      if (_.isObject(_data)) {
+      if (isObject(_data)) {
         if (Array.isArray(_data.content) && _data.pageNumber) {
           _data.list = _data.content;
           _data.pagination = { current: _data.pageNumber, total: _data.total };

package/src/hooks.ts

@@ -1,38 +1,38 @@
-import { useMemo, useRef } from "react";
-import { merge } from "lodash";
-import DataModel, { DataModelOptions } from "./data-model";
-
-/**
- * useDataModel 选项接口
- */
-export interface UseDataModelOptions<T = any> {
-  /** 动态数据监听的目标 */
-  effectTargets?: any[];
-  /** 动态的 params 数据，包含了 query */
-  effectParams?: Partial<DataModelOptions<T>>;
-  /** 动态的 query 数据 */
-  effectQuery?: DataModelOptions<T>["query"];
-}
-
-/**
- * 解决 hooks 重复实例化导致 query 丢失的问题
- * @param {Object} initParams 初始参数
- * @param {Object} opt
- * @param {Object} opt.effectTargets 动态数据监听的目标
- * @param {Object} opt.effectParams 动态的 params 数据，包含了 query
- * @param {Object} opt.effectQuery 动态的 query 数据
- * @returns DataModel 实例
- */
-export const useDataModel = function <T = any>(initParams: DataModelOptions<T> = {}, opt: UseDataModelOptions<T> = {}) {
-  const model = useRef<DataModel<T>>(new DataModel(initParams));
-  return useMemo(() => {
-    const { effectParams, effectQuery } = opt || {};
-    if (effectParams) {
-      merge(model.current, effectParams);
-    }
-    if (effectQuery) {
-      merge(model.current.query, effectQuery);
-    }
-    return model.current;
-  }, opt.effectTargets || []);
-};
+import { useMemo, useRef } from "react";
+import { merge } from "lodash-es";
+import DataModel, { DataModelOptions } from "./data-model";
+
+/**
+ * useDataModel 选项接口
+ */
+export interface UseDataModelOptions<T = any> {
+  /** 动态数据监听的目标 */
+  effectTargets?: any[];
+  /** 动态的 params 数据，包含了 query */
+  effectParams?: Partial<DataModelOptions<T>>;
+  /** 动态的 query 数据 */
+  effectQuery?: DataModelOptions<T>["query"];
+}
+
+/**
+ * 解决 hooks 重复实例化导致 query 丢失的问题
+ * @param {Object} initParams 初始参数
+ * @param {Object} opt
+ * @param {Object} opt.effectTargets 动态数据监听的目标
+ * @param {Object} opt.effectParams 动态的 params 数据，包含了 query
+ * @param {Object} opt.effectQuery 动态的 query 数据
+ * @returns DataModel 实例
+ */
+export const useDataModel = function <T = any>(initParams: DataModelOptions<T> = {}, opt: UseDataModelOptions<T> = {}) {
+  const model = useRef<DataModel<T>>(new DataModel(initParams));
+  return useMemo(() => {
+    const { effectParams, effectQuery } = opt || {};
+    if (effectParams) {
+      merge(model.current, effectParams);
+    }
+    if (effectQuery) {
+      merge(model.current.query, effectQuery);
+    }
+    return model.current;
+  }, opt.effectTargets || []);
+};