zzz-pc-view 0.0.28 → 0.0.30

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zzz-pc-view",
-  "version": "0.0.28",
+  "version": "0.0.30",
   "main": "src/index.umd.js",
   "module": "src/index.es.js",
   "types": "src/index.d.ts",
@@ -24,6 +24,8 @@
     "element-plus": "^2.9.1",
     "color-hash": "^2.0.2",
     "animate.css": "^4.1.1",
-    "mitt": "^3.0.1"
+    "mitt": "^3.0.1",
+    "@types/mockjs": "^1.0.10",
+    "mockjs": "^1.1.0"
   }
 }

package/src/decorators/CurdKey/index.d.ts

@@ -7,6 +7,7 @@ import { Config as NameKeyConfig } from './../NameKey';
 import { RequestUtilResponse } from '../useRequestUtil';
 import { ZUtils } from '../../index-decorators';
 export * from './CurdApi';
+export * from './useCurdMock';
 /**
  * 基础参数接口，用于定义通用的参数属性。
  */

package/src/decorators/CurdKey/useCurdMock.d.ts

@@ -0,0 +1,82 @@
+import { ZUtils } from '../../index-decorators';
+/**
+ * 定义一个 Mock 监听器接口，用于配置 Mock 请求的相关信息
+ */
+export interface MockListener {
+    method?: 'GET' | 'get' | 'POST' | 'post' | 'PUT' | 'put' | 'DELETE' | 'delete';
+    template?: any | ((params: any) => any);
+}
+/**
+ * 定义 Mock 分页配置接口，继承自 MockListener 接口，用于配置分页请求和响应的属性
+ * @extends MockListener
+ */
+export interface MockPagination extends MockListener {
+    /**
+     * 分页请求参数的属性名配置
+     */
+    pageRequestProps: {
+        /**
+         * 请求中表示当前页码的属性名
+         */
+        page: string;
+        /**
+         * 请求中表示每页数据条数的属性名
+         */
+        size: string;
+    };
+    /**
+     * 分页响应数据的属性名配置
+     */
+    pageResponseProps: {
+        /**
+         * 响应中表示数据总条数的属性名
+         */
+        total: string;
+        /**
+         * 响应中表示数据列表的属性名
+         */
+        list: string;
+    };
+}
+/**
+ * 定义一个用于过滤列表数据的函数类型接口
+ * @param list - 待过滤的列表数据，类型为泛型 T 的数组
+ * @param query - 可选的查询参数，类型为任意类型
+ * @returns 返回过滤后的列表数据，类型为泛型 T 的数组
+ */
+export interface MockListFilter<T> {
+    (list: T[], query?: any): T[];
+}
+/**
+ * 创建一个用于模拟 CRUD 操作的钩子函数
+ * @param option - 配置选项
+ * @param option.basePath - 基础路径
+ * @param option.Target - 目标类
+ * @param option.list - 初始列表数据
+ * @param option.listFilter - 列表过滤器，可选
+ * @param option.listener - 监听器配置
+ * @param option.listener.list - 列表请求监听器，可选
+ * @param option.listener.page - 分页请求监听器，可选
+ * @param option.listener.create - 创建请求监听器，可选
+ * @param option.listener.detail - 详情请求监听器，可选
+ * @param option.listener.update - 更新请求监听器，可选
+ * @param option.listener.delete - 删除请求监听器，可选
+ * @returns 包含列表和映射对象的对象
+ */
+export declare const useCurdMock: <T extends ZUtils.ClassType>(option: {
+    basePath: string;
+    Target: T;
+    list: InstanceType<T>[];
+    listFilter?: MockListFilter<InstanceType<T>>;
+    listener: {
+        list?: MockListener;
+        page?: MockPagination;
+        create?: MockListener;
+        detail?: MockListener;
+        update?: MockListener;
+        delete?: MockListener;
+    };
+}) => {
+    readonly list: InstanceType<T>[];
+    readonly map: Record<PropertyKey, InstanceType<T>>;
+};