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

package/src/{hooks.js → hooks.ts}

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

package/src/{index.js → index.ts}

@@ -4,6 +4,7 @@ import DataModel from "./data-model";
 export * from "./axios";
 export * from "./data-model";
 export * from "./hooks";
+export * from "./type";
 
 export { axios, DataModel };
 

package/src/{public-utils.js → public-utils.ts}

@@ -1,9 +1,18 @@
+/**
+ * getPublicUrl 选项接口
+ */
+export interface GetPublicUrlOptions {
+  /** 是否返回完整路径 */
+  isFullPath?: boolean;
+}
+
 /**
  * 获取 public 文件路径（自动拼接 hash 数据）
- * @param {*} url 文件路径
- * @param {*} opt
+ * @param url 文件路径
+ * @param opt 选项
+ * @returns 完整的 public 文件路径
  */
-export function getPublicUrl(url, opt = {}) {
+export function getPublicUrl(url: string | any, opt?: GetPublicUrlOptions): string | any {
   if (typeof url !== "string") {
     return url;
   }

package/src/type.ts

@@ -0,0 +1,98 @@
+import { AxiosRequestConfig, AxiosInstance, AxiosResponse } from "axios";
+
+/**
+ * 通用 JSON 对象类型
+ */
+export type JSONObject = Record<string, any>;
+
+/**
+ * 查询参数类型
+ */
+export type QueryParams = JSONObject;
+
+/**
+ * 请求数据类型
+ */
+export type RequestData = JSONObject;
+
+/**
+ * 响应数据类型
+ */
+export type ResponseData = JSONObject;
+
+/**
+ * Axios 配置类型
+ */
+export type AxiosConfig = AxiosRequestConfig;
+
+/**
+ * 数据映射函数类型
+ * @template T - 输入类型
+ * @template R - 输出类型（默认为 T）
+ */
+export type MapFunction<T = any, R = T> = (data: T) => R;
+
+/**
+ * 带原始参数的映射函数类型（用于请求前处理）
+ * @template T - 处理后的参数类型
+ * @template P - 原始参数类型
+ */
+export type RequestMapFunction<T = RequestData, P = any> = (params: T, originalParams?: P) => T;
+
+/**
+ * 列表请求返回结果接口
+ * @template T - 列表项数据类型
+ */
+export interface GetListResult<T = any> {
+  /** 列表数据 */
+  list: T[];
+  /** 分页信息 */
+  pagination: { current?: number; total: number; pageSize?: number };
+  /** 其他扩展字段 */
+  [key: string]: any;
+}
+
+/**
+ * 自定义列表请求函数类型
+ * @template T - 列表项数据类型
+ */
+export type GetListFunc<T = any> = (query: QueryParams) => Promise<GetListResult<T>>;
+
+/**
+ * 响应处理函数类型
+ */
+export type HandleResponseFunc = (response: AxiosResponse) => ResponseData;
+
+/**
+ * API 错误接口
+ */
+export interface ApiError extends Error {
+  /** 错误码 */
+  code?: number | string;
+  /** 响应对象 */
+  response?: AxiosResponse;
+  /** 错误消息（带下划线前缀） */
+  _msg?: string;
+  /** 错误消息（带下划线前缀） */
+  _message?: string;
+  /** 原始错误数据 */
+  data?: any;
+}
+
+/**
+ * 网络链接信息接口（非标准 API）
+ */
+export interface NetworkConnection {
+  type?: string;
+  downlink?: number;
+  effectiveType?: string;
+}
+
+/**
+ * 扩展 Navigator 接口（包含非标准连接属性）
+ */
+export interface ExtendedNavigator extends Navigator {
+  connection?: NetworkConnection;
+  mozConnection?: NetworkConnection;
+  webkitConnection?: NetworkConnection;
+}

package/src/{utils.js → utils.ts}

@@ -4,16 +4,22 @@ const DEFAULT_MSG = "未知错误";
 const NETWORK_MSG = "网络异常，请检查网络是否开启";
 
 /** 暂存相关变量 */
-export const _$Temp = {
+export interface TempStore {
+  defaultErrMsg: string;
+  networkErrMsg: string;
+  axios?: any;
+}
+
+export const _$Temp: TempStore = {
   defaultErrMsg: DEFAULT_MSG,
   networkErrMsg: NETWORK_MSG,
 };
 
 /**
  * 设置默认的 axios
- * @param {*} ax
+ * @param ax axios 实例
  */
-export function setDefaultAxios(ax) {
+export function setDefaultAxios(ax: any) {
   if (ax) {
     _$Temp.axios = ax;
   }
@@ -21,9 +27,9 @@ export function setDefaultAxios(ax) {
 
 /**
  * 设置默认的错误提示文案
- * @param {*} ax
+ * @param msg 错误提示文案
  */
-export function setDefaultErrMsg(msg) {
+export function setDefaultErrMsg(msg: string) {
   if (msg) {
     _$Temp.defaultErrMsg = msg;
   }
@@ -31,9 +37,9 @@ export function setDefaultErrMsg(msg) {
 
 /**
  * 设置默认的网络异常提示文案
- * @param {*} ax
+ * @param msg 网络异常提示文案
  */
-export function setNetworkErrMsg(msg) {
+export function setNetworkErrMsg(msg: string) {
   if (msg) {
     _$Temp.networkErrMsg = msg;
   }
@@ -41,17 +47,17 @@ export function setNetworkErrMsg(msg) {
 
 /**
  * 检测网络状态
- * @param {*} errMsg 网络异常消息
- * @returns
+ * @returns 网络是否可用
  */
-export function checkNetwork() {
-  if (!navigator) {
+export function checkNetwork(): boolean {
+  if (typeof navigator === "undefined") {
     return true;
   }
   if (navigator.onLine === false) {
     return false;
   }
-  const connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection;
+  const _navigator = navigator as any;
+  const connection = _navigator.connection || _navigator.mozConnection || _navigator.webkitConnection;
   if (!connection) {
     return true;
   }
@@ -61,10 +67,10 @@ export function checkNetwork() {
 
 /**
  * 对象转 FormData 格式
- * @param {Object} data
- * @returns
+ * @param data 对象数据
+ * @returns FormData 对象
  */
-export function objToFormData(data) {
+export function objToFormData(data: Record<string, any>): FormData {
   if (data instanceof FormData) {
     return data;
   }
@@ -77,14 +83,14 @@ export function objToFormData(data) {
 
 /**
  * FormData 转对象
- * @param {FormData} formData
- * @returns
+ * @param formData FormData 对象
+ * @returns 普通对象
  */
-export function formDataToObj(formData) {
+export function formDataToObj(formData: FormData | any): Record<string, any> {
   if (!(formData instanceof FormData)) {
     return formData;
   }
-  const tempData = {};
+  const tempData: Record<string, any> = {};
   for (const [key, value] of formData.entries()) {
     tempData[key] = value;
   }