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

package/CHANGELOG.md

@@ -1,152 +1,11 @@
-# @hzab/data-model@2.1.0
+# @hzab/data-model
+
+## 2.1.0-alpha.0
+
+### Minor Changes
+
+- 接入重构版 data-model
 
-refactor: lodash 改为 lodash-es
-feat: RequestCache 接口缓存工具类
+## 0.0.1
 
-# @hzab/data-model@2.0.2
-
-fix: getList \_data.content total == 0 情况处理
-
-# @hzab/data-model@2.0.1
-
-feat: ReqMap 支持异步
-
-# @hzab/data-model@2.0.0
-
-break: axios 默认导出实例化后的 axios 实例，axios 源对象通过 axiosDef 导出
-refactor: js 文件改为 js 文件
-
-# @hzab/data-model@1.8.8
-
-feat: array-data-model 支持 query 过滤
-
-# @hzab/data-model@1.8.6
-
-fix: getToken opt.hasCookie 是否读取 cookie 的 token。默认不读取 cookie 的 token
-fix: setToken 默认不设置到 cookie 上
-
-# @hzab/data-model@1.8.4
-
-fix: response undefined 兼容处理
-
-# @hzab/data-model@1.8.3
-
-fix: 无 response 默认返回网络异常文案
-
-# @hzab/data-model@1.8.2
-
-fix: errorHandler err 为 undefined 的情况兼容
-
-# @hzab/data-model@1.8.1
-
-fix: handleMsg 新增 response.message 获取
-
-# @hzab/data-model@1.8.0
-
-fix: public utils getPublicUrl 多层目录问题修复 isFullPath
-
-# @hzab/data-model@1.7.6
-
-feat: getPublicUrl 获取 public 文件路径（自动拼接 hash 数据）
-
-# @hzab/data-model@1.7.5
-
-fix: array-data-model 数据报错异常处理
-
-# @hzab/data-model@1.7.4
-
-fix: axios 拦截优化，解决请求取消异常问题
-
-# @hzab/data-model@1.7.3
-
-fix: axios 统一
-
-# @hzab/data-model@1.7.2
-
-feat: axios.js getCancelTokenSource 获取 axios.CancelToken.source， 用于取消请求
-
-# @hzab/data-model@1.7.1
-
-feat: sortKey/orderByColumn 支持对象格式，支持定义数据类型、自定义数据处理函数；自定义数据对比函数
-
-# @hzab/data-model@1.7.0
-
-feat: 本地数据支持排序查询列表数据
-
-# @hzab/data-model@1.6.1
-
-fix: array-data-modal getMap getListMap 修复；getListMap、getListResMap 逻辑优化
-
-# @hzab/data-model@1.6.0
-
-fix: 注释；通用函数抽离
-feat: ArrayDataModel 本地数据 DataModel
-
-# @hzab/data-model@1.5.0
-
-- feat: 增加 patch 请求方式函数
-
-# @hzab/data-model@1.4.1
-
-- fix: handleMsg useStatusText 问题修复
-
-# @hzab/data-model@1.4.0
-
-- 兼容分页列表是 content 及相关数据同层的问题 data: { content: [], pageNumber: 1, pageSize: 10, total: 0 }
-- handleResponse 统一 response 回调，用于处理定制 response 格式
-
-# @hzab/data-model@1.3.1
-
-- fix: useStatusText: true 问题修复
-
-# @hzab/data-model@1.3.0
-
-- feat: 网络情况判断
-- feat: 新增参数 isResponseData 是否返回完整的接口数据（response.data）； isResponse 是否直接返回 response
-
-# @hzab/data-model@1.2.1
-
-- fix: setAxTimeout default timeout 0
-
-# @hzab/data-model@1.2.0
-
-- feat: 增删改查 axiosConf 允许独立配置 xxxAxiosConf。如： createAxiosConf
-
-# @hzab/data-model@1.1.1
-
-- fix: formData header 覆盖问题修复
-
-# @hzab/data-model@1.1.0
-
-- formData 问题修复
-
-# @hzab/data-model@1.0.2
-
-- fix: getApiUrl 增加调用来源，错误提示增加入参展示
-
-# @hzab/data-model@1.0.1
-
-- fix: 修复 delete 入参问题
-- fix: getApiUrl :xx 参数替换正则处理
-
-# @hzab/data-model@0.2.3
-
-- fix: axios delete 入参写法问题修复
-
-# @hzab/data-model@0.2.2
-
-- feat: useDataModel，解决 hooks 写法 model 重复实例化导致 query 丢失的问题
-
-# @hzab/data-model@0.1.2
-
-- 错误信息逻辑修复
-- status 错误信息
-- 默认错误信息
-
-# @hzab/data-model@0.1.0
-
-- token 设置在 cookie 中
-
-# @hzab/data-model@0.0.1
-
-组件初始化
+- 初始化包骨架（2.1 唯一发布物：再导出 core + `useDataModel`）。

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 @hzab/react-maintainers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,270 +1,50 @@
-# @hzab/data-model
-
-组件模板
-
-- node@14.21
-
-# 组件
-
-## 示例
-
-```jsx
-import DataModel, {
-  // 设置 token 到 localStorage 及 cookie，可以设置 opt.hasCookie（setToken(token, { hasCookie: false })） 关闭设置 token 到 cookie 上
-  setToken,
-  // 从 cookie 或 localStorage 获取 token
-  getToken,
-  // 设置默认兜底的错误信息
-  setDefaultErrMsg,
-  // 设置默认网络异常的错误信息
-  setNetworkErrMsg,
-  // 设置 DataModel 中默认的 axios
-  setDefaultAxios,
-} from "@hzab/data-model";
-
-const listDM = new DataModel({
-  // query 参数
-  query,
-  // 新增接口 post url
-  createApi,
-  // 新增接口 post 入参枚举函数
-  createMap,
-  // 详情接口 get url
-  getApi,
-  // 详情接口 get 出参枚举函数
-  getMap,
-  // 详情接口 get url
-  getListApi,
-  // 列表接口 get 出参枚举函数
-  getListMap,
-  // 列表请求函数
-  getListFunc,
-  // put 编辑接口 url
-  updateApi,
-  // put 编辑接口 入参枚举函数
-  updateMap,
-  // patch 编辑接口 url
-  patchApi,
-  // patch 编辑接口 入参枚举函数
-  patchMap,
-  // 删除接口 delete url
-  deleteApi,
-  // 批量删除接口 delete url
-  multipleDeleteApi,
-  // 统一 response 回调，用于处理定制 response 格式
-  handleResponse,
-  // axios 实例对象
-  axios,
-  // axios 相关配置
-  axiosConf,
-  // getList 接口 axios 相关配置
-  getListAxiosConf,
-  // get 接口 axios 相关配置
-  getAxiosConf,
-  // create 接口 axios 相关配置
-  createAxiosConf,
-  // update 接口 axios 相关配置
-  updateAxiosConf,
-  // patch 接口 axios 相关配置
-  patchAxiosConf,
-  // delete 接口 axios 相关配置
-  deleteAxiosConf,
-  // multipleDelete 接口 axios 相关配置
-  multipleDeleteAxiosConf,
-  // 列表接口 get 入参枚举函数
-  getListReqMap,
-  // 列表接口 get 出参枚举函数
-  getListResMap,
-  // 详情接口 get 入参枚举函数
-  getReqMap,
-  // 详情接口 get 出参枚举函数
-  getResMap,
-  // 新增接口 post 入参枚举函数
-  createReqMap,
-  // 新增接口 post 出参枚举函数
-  createResMap,
-  // 编辑接口 put 入参枚举函数
-  updateReqMap,
-  // 编辑接口 put 出参枚举函数
-  updateResMap,
-  // patch 编辑接口 put 入参枚举函数
-  patchReqMap,
-  // patch 编辑接口 put 出参枚举函数
-  patchResMap,
-  // 删除接口 delete 入参枚举函数
-  deleteReqMap,
-  // 删除接口 delete 出参枚举函数
-  deleteResMap,
-  // 批量删除接口 delete 入参枚举函数
-  multipleDeleteReqMap,
-  // 批量删除接口 delete 出参枚举函数
-  multipleDeleteResMap,
-  // 是否返回完整的接口数据（response.data）
-  isResponseData,
-  // 是否直接返回 response
-  isResponse,
-});
-
-// useDataModel，解决 hooks 写法 model 重复实例化导致 query 丢失的问题
-function Demo({ orgId }) {
-  // 第一个入参同 new DataModel，第二个参数为需要监听的动态参数数组
-  const model = useDataModel(
-    // 初始值
-    {
-      getListApi: "/getList",
-      query: { orgId },
-    },
-    {
-      // 动态的 params 数据
-      effectParams: { orgId },
-      // 动态 query 数据
-      effectQuery: { orgId },
-      // 动态数据监听的值
-      effectTargets: [orgId],
-    },
-  );
-  return <ListRender model={model} />;
-}
-```
-
-
-#### 重复请求拦截
-```tsx
-import RequestCache from "@hzab/data-model/RequestCache";
-import { AxiosRequestConfigWithCache, setAxRequest } from "@hzab/data-model";
-
-const requestCache = new RequestCache({ options: { cacheTTL: 2000 } });
-
-setAxRequest((config: AxiosRequestConfigWithCache) => {
-  // 拦截 get 请求
-  if (config.method.toLowerCase() === "get") {
-    return requestCache.handleAxRequest(config);
-  }
-  return config;
-});
-```
-
-## DataModel
-
-| 参数                    | 类型     | 必填 | 默认值 | 说明                                           |
-| ----------------------- | -------- | ---- | ------ | ---------------------------------------------- |
-| query                   | Object   | 否   | -      | query 参数对象                                 |
-| createApi               | string   | 否   | -      | post 接口地址                                  |
-| getApi                  | string   | 否   | -      | 详情 get 接口地址                              |
-| getListApi              | string   | 否   | -      | 列表 get 接口地址                              |
-| updateApi               | string   | 否   | -      | put 接口地址                                   |
-| patchApi                | string   | 否   | -      | patch 接口地址                                 |
-| deleteApi               | string   | 否   | -      | delete 接口地址                                |
-| multipleDeleteApi       | string   | 否   | -      | 批量删除 delete 接口地址                       |
-| createMap               | Function | 否   | -      | createApi 接口提交前的处理函数                 |
-| getMap                  | Function | 否   | -      | getApi 接口返回结果的处理函数                  |
-| getListMap              | Function | 否   | -      | getListApi 接口返回结果的处理函数              |
-| getListFunc             | Function | 否   | -      | 自定义的列表请求函数，优先级高于 getListApi    |
-| updateMap               | Function | 否   | -      | updateApi 接口提交前的处理函数                 |
-| patchMap                | Function | 否   | -      | patchApi 接口提交前的处理函数                  |
-| axios                   | Object   | 否   | -      | axios 实例对象                                 |
-| axiosConf               | Object   | 否   | -      | axios 相关配置                                 |
-| getListAxiosConf        | Object   | 否   | -      | getList 接口 axios 相关配置                    |
-| getAxiosConf            | Object   | 否   | -      | get 接口 axios 相关配置                        |
-| createAxiosConf         | Object   | 否   | -      | create 接口 axios 相关配置                     |
-| updateAxiosConf         | Object   | 否   | -      | update 接口 axios 相关配置                     |
-| patchAxiosConf          | Object   | 否   | -      | patch 接口 axios 相关配置                      |
-| deleteAxiosConf         | Object   | 否   | -      | delete 接口 axios 相关配置                     |
-| multipleDeleteAxiosConf | Object   | 否   | -      | multipleDelete 接口 axios 相关配置             |
-| getListReqMap           | Function | 否   | -      | 列表接口 get 入参枚举函数                      |
-| getListResMap           | Function | 否   | -      | 列表接口 get 出参枚举函数                      |
-| getReqMap               | Function | 否   | -      | 详情接口 get 入参枚举函数                      |
-| getResMap               | Function | 否   | -      | 详情接口 get 出参枚举函数                      |
-| createReqMap            | Function | 否   | -      | 新增接口 get 入参枚举函数                      |
-| createResMap            | Function | 否   | -      | 新增接口 get 出参枚举函数                      |
-| updateReqMap            | Function | 否   | -      | 编辑接口 get 入参枚举函数                      |
-| updateResMap            | Function | 否   | -      | 编辑接口 get 出参枚举函数                      |
-| patchReqMap             | Function | 否   | -      | patch 接口 get 入参枚举函数                    |
-| patchResMap             | Function | 否   | -      | patch 接口 get 出参枚举函数                    |
-| deleteReqMap            | Function | 否   | -      | 删除接口 get 入参枚举函数                      |
-| deleteResMap            | Function | 否   | -      | 删除接口 get 出参枚举函数                      |
-| multipleDeleteReqMap    | Function | 否   | -      | 批量删除接口 get 入参枚举函数                  |
-| multipleDeleteResMap    | Function | 否   | -      | 批量删除接口 get 出参枚举函数                  |
-| isResponseData          | boolean  | 否   | -      | 是否返回完整的接口数据（response.data）        |
-| isResponse              | boolean  | 否   | -      | 是否直接返回 response                          |
-| handleResponse          | Function | 否   | -      | 统一 response 回调，用于处理定制 response 格式 |
-
-## useDataModel
-
-| 参数              | 类型   | 必填 | 默认值 | 说明                             |
-| ----------------- | ------ | ---- | ------ | -------------------------------- |
-| initParams        | Object | 是   | -      | 初始参数，通同 DataModel         |
-| opt               | Object | 否   | -      | 配置参数                         |
-| opt.effectTargets | Object | 否   | -      | 动态数据监听的目标               |
-| opt.effectParams  | Object | 否   | -      | 动态的 params 数据，包含了 query |
-| opt.effectQuery   | Object | 否   | -      | 动态的 query 数据                |
-
-## array-data-model
-
-- 参数通 DataModel
-
-### query 配置
-
-| 参数                  | 类型                                      | 必填 | 默认值 | 说明                                                      |
-| --------------------- | ----------------------------------------- | ---- | ------ | --------------------------------------------------------- |
-| sortKey/orderByColumn | string/Object/Array[string]/Array[Object] | 否   | -      | 排序字段，支持多维度排序，按照传入的顺序排优先级          |
-| sortType/isAsc        | string/Object                             | 否   | -      | 排序规则，支持对象配置各字段排序规则 正序: asc 倒序: desc |
-
-### sortKey/orderByColumn Object 配置
-
-| 参数          | 类型     | 必填 | 默认值 | 说明                                                                                                                                      |
-| ------------- | -------- | ---- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| path          | string   | 否   | -      | path 取值路径字符串                                                                                                                       |
-| type          | string   | 否   | -      | 值类型 用于进行内部相关转换 date                                                                                                          |
-| customFormat  | Function | 否   | -      | 自定义数据处理函数                                                                                                                        |
-| customCompare | Function | 否   | -      | 自定义数据对比函数 (a, b)=>number，如果 a 小于 b，返回值为负数，如果 a 大于 b，返回值为正数，如果两个元素相等，返回值为 0。NaN 被视为 0。 |
-
-- type 目前支持的类型: date
-
-# 组件开发流程
-
-- 在 config/webpack.config.js 中按需修改 library 配置的文件名
-- 在 config/webpack.config.js 中按需修改 alias 配置的包名，便于本地调试
-- 在 tsconfig.json 中按需修改 paths 配置的包名，解决 ts 报错问题
-- npm run dev
-
-## 文件目录
-
-- example 本地开发测试代码
-- src 组件源码
-
-## 命令
-
-- 生成文档：npm run docs
-- 本地运行：npm run dev
-- 打包编译：npm run build
-
-## 发布
-
-- npm 源和云效源都需要发布
-
-- 命令：npm publish --access public
-- 发布目录：
-  - src
-
-### nrm
-
-- 安装
-  npm install -g nrm
-- 增加源
-  nrm add aliyun https://packages.aliyun.com/62046985b3ead41b374a17f7/npm/npm-registry/
-- 切换源
-  nrm use aliyun
-  nrm use npm
-- 登录（账号密码在 https://packages.aliyun.com/npm/npm-registry/guide 查看）
-  npm login --registry=https://packages.aliyun.com/62046985b3ead41b374a17f7/npm/npm-registry/
-
-## 配置
-
-### 配置文件
-
-- 本地配置文件：config/config.js
-
-### webpack 配置文件
-
-- config/webpack.config.js
+# @hzab/data-model
+
+数据模型 2.1：再导出 `@hzab/data-model-core`（打进 dist，不单独发布），并提供 `useDataModel`。后继 API 与 2.x 旧写法双轨。
+
+老页面继续 `import { useDataModel, DataModel, axios } from "@hzab/data-model"`。不要安装 `@hzab/data-model-core`。
+
+## 安装
+
+```bash
+pnpm add @hzab/data-model
+```
+
+peer：`react` `^17 || ^18 || ^19`（使用 `useDataModel` 时由消费方提供）。
+
+## 用法
+
+### 新页面（后继 API）
+
+```ts
+import DataModel, { axios, createAxiosClient } from "@hzab/data-model";
+
+const model = DataModel.getInstance("items", {
+  getListApi: "/api/items",
+  responseAdapter: {},
+});
+model.configure({ query: { tenantId: "1" } });
+```
+
+### 旧写法（useDataModel / 旧 list-render）
+
+```ts
+import { useDataModel } from "@hzab/data-model";
+
+const model = useDataModel({ getListApi: "/api/items", query: { tenantId: "1" } });
+model
+  .getList({})
+  .catch((err) => {
+    if (err?.code === "ERR_CANCELED") return;
+    throw err;
+  });
+```
+
+取消请求由调用方 catch `ERR_CANCELED`（模型不再静默不 settle）。
+
+计划：[docs/data-model-from-ccc-plan.md](../../../docs/data-model-from-ccc-plan.md)。
+
+## 维护
+
+- Owner：@hzab/react-maintainers
+- 层级：react（唯一发布物）