zzz-pc-view 0.0.1

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

@@ -0,0 +1,221 @@
+import { AxiosResponse } from 'axios';
+import { httpRequest, CombineInstanceType, KeyMatch } from '../../utils';
+import { TypeWithPrototype, TypeWithPrototypeWithoutNew } from '../DeclareType';
+import { Reactive } from 'vue';
+/**
+ * 定义编辑类型的枚举。
+ * @enum {number}
+ */
+export declare enum EditTypeEnum {
+    CREATE = 1,
+    DETAIL = 2,
+    UPDATE = 6
+}
+/**
+ * 定义编辑类型映射的常量对象。
+ * @const
+ * @type {Object}
+ */
+export declare const editTypeMap: {
+    /**
+     * 创建操作的配置。
+     * @type {Object}
+     * @property {EditTypeEnum.CREATE} id - 操作的ID，对应EditTypeEnum.CREATE。
+     * @property {() => string} getLabel - 获取操作标签的函数，返回'新增'。
+     * @property {string} method - 操作的HTTP方法，为'POST'。
+     */
+    readonly 1: {
+        readonly id: EditTypeEnum.CREATE;
+        readonly getLabel: () => string;
+        readonly method: "POST";
+    };
+    /**
+     * 详情操作的配置。
+     * @type {Object}
+     * @property {EditTypeEnum.DETAIL} id - 操作的ID，对应EditTypeEnum.DETAIL。
+     * @property {string} label - 操作的标签，为'详情'。
+     * @property {string} method - 操作的HTTP方法，为'GET'。
+     */
+    readonly 2: {
+        readonly id: EditTypeEnum.DETAIL;
+        readonly label: "详情";
+        readonly method: "GET";
+    };
+    /**
+     * 更新操作的配置。
+     * @type {Object}
+     * @property {EditTypeEnum.UPDATE} id - 操作的ID，对应EditTypeEnum.UPDATE。
+     * @property {string} label - 操作的标签，为'修改'。
+     * @property {string} method - 操作的HTTP方法，为'PUT'。
+     */
+    readonly 6: {
+        readonly id: EditTypeEnum.UPDATE;
+        readonly label: "修改";
+        readonly method: "PUT";
+    };
+};
+/**
+ * 定义保存类型映射的类型。
+ */
+export type EditTypeMap = typeof editTypeMap;
+/**
+ * 定义保存类型的类型。
+ */
+export type EditType = EditTypeMap[EditTypeEnum];
+/**
+ * 定义保存类型的键类型。
+ */
+export type EditTypeId = keyof EditTypeMap;
+/**
+ * 定义分页响应的接口。
+ * @template T - 响应中列表项的类型。
+ */
+export interface PaginationResponse<T> {
+    list: T[];
+    total: number;
+}
+/**
+ * 定义分页响应构造函数的接口。
+ * @template T - 响应中列表项的类型。
+ */
+export interface PaginationResponseConstructor<T> extends TypeWithPrototypeWithoutNew {
+    new (data: PaginationResponse<T>): PaginationResponse<T>;
+}
+/**
+ * 定义 CURD（创建、读取、更新、删除）操作的 API 类。
+ * @template T - 表示操作的数据类型，默认为 `object`。
+ * @template P - 表示分页响应的构造函数类型，默认为 `PaginationResponseConstructor<T>`。
+ */
+export declare class CurdApi<T extends object = object, P extends PaginationResponseConstructor<T> = PaginationResponseConstructor<T>> {
+    /**
+     * 目标类的构造函数。
+     * @protected
+     * @type {TypeWithPrototype}
+     */
+    protected readonly Target: TypeWithPrototype;
+    /**
+     * API 的基础路径。
+     * @protected
+     * @type {string}
+     */
+    protected readonly basePath: string;
+    /**
+     * 树形结构的键配置。
+     * @description 这个属性是可选的，如果提供了树形结构的键配置，则在处理树形数据时会使用它。
+     * @description 树形结构的键配置包含三个属性：
+     * @description - `childrenKey`：用于获取子节点的键匹配函数。
+     * @description - `parentIdKey`：用于获取父节点ID的键匹配函数。
+     * @description - `sortKey`：用于排序节点的键匹配函数（可选）。
+     * @type {Object}
+     * @property {KeyMatch<T, undefined | T[]>} childrenKey - 用于获取子节点的键匹配函数。
+     * @property {KeyMatch<T, undefined | null | PropertyKey>} parentIdKey - 用于获取父节点ID的键匹配函数。
+     * @property {KeyMatch<T, undefined | number>} [sortKey] - 用于排序节点的键匹配函数（可选）。
+     * @optional
+     */
+    protected readonly treeKey?: {
+        childrenKey: KeyMatch<T, undefined | T[]>;
+        parentIdKey: KeyMatch<T, undefined | null | PropertyKey>;
+        sortKey?: KeyMatch<T, undefined | number>;
+    };
+    /**
+     * 分页响应的类。
+     * @protected
+     * @type {P}
+     */
+    protected readonly PaginationResponseClass?: P;
+    get hasServerPagination(): boolean;
+    /**
+     * 是否使用文件上传保存数据。
+     * @protected
+     * @type {boolean}
+     */
+    protected readonly saveWithUploadFile: boolean;
+    /**
+     * 获取列表数据。
+     * @description 该方法用于从API获取列表数据，并根据需要进行数据绑定和树形结构处理。
+     * @description 如果提供了查询参数，则会将其作为查询字符串附加到URL中。
+     * @description 如果API返回的数据是数组，则会将其绑定到目标类，并根据树形结构配置进行处理。
+     * @description 最后，返回一个包含处理后数据的Promise。
+     * @param {T | Reactive<T>} [query] - 查询参数，可以是普通对象或Vue的响应式对象。
+     * @returns {Promise<T[]>} - 返回一个包含列表数据的Promise。
+     */
+    getList(query?: T | Reactive<T>): httpRequest.HttpRequestPromise<T[]>;
+    /**
+     * 分页获取列表数据。
+     * @param {object} pagination - 分页参数。
+     * @param {T | Reactive<T>} [query] - 查询参数。
+     * @returns {Promise<CombineInstanceType<P>>} - 返回一个包含分页数据的 Promise。
+     */
+    getListByPage(pagination: object, query?: T | Reactive<T>): httpRequest.HttpRequestPromise<Awaited<CombineInstanceType<P>>>;
+    /**
+     * 获取指定数据的详细信息。
+     * 这个方法会根据传入的数据对象的ID，从API获取该数据的详细信息，并将其绑定到目标类。
+     * @param {T} data - 包含ID的数据对象。
+     * @returns {Promise<T>} - 返回一个包含详细信息的Promise。
+     */
+    getDetail(data: T): httpRequest.HttpRequestPromise<Awaited<T>>;
+    /**
+     * 保存数据。
+     * @param {T} data - 要保存的数据对象。
+     * @param {EditTypeId} saveTypeId - 保存类型的 ID。
+     * @returns {Promise<any>} - 返回一个包含保存结果的 Promise。
+     */
+    save(data: T, saveTypeId: EditTypeId): httpRequest.HttpRequestPromise<unknown>;
+    /**
+     * 删除数据。
+     * @param {T} data - 包含 ID 的数据对象。
+     * @returns {Promise<any>} - 返回一个包含删除结果的 Promise。
+     */
+    delete(data: T): httpRequest.HttpRequestPromise<unknown>;
+    /**
+     * 更改数据状态。
+     * @param {T} data - 包含 ID 的数据对象。
+     * @param {number | boolean} state - 新的状态值。
+     * @returns {Promise<any>} - 返回一个包含更改结果的 Promise。
+     */
+    changeState(data: T, state: number | boolean): httpRequest.HttpRequestPromise<unknown>;
+    /**
+     * 导出数据。
+     * 该方法用于从API导出数据，并将其作为Blob对象返回。
+     * 如果提供了查询参数，则会将其作为请求体发送到API。
+     * 最后，返回一个包含导出结果的Promise。
+     * @param {T | Reactive<T>} [query] - 查询参数，可以是普通对象或Vue的响应式对象。
+     * @returns {Promise<any>} - 返回一个包含导出结果的Promise。
+     */
+    export(query?: T | Reactive<T>): httpRequest.HttpRequestPromise<void>;
+    /**
+     * 获取数据对象的ID。
+     * @param {T} data - 包含ID的数据对象。
+     * @returns {any} - 返回数据对象的ID。
+     */
+    protected getId(data: T): never;
+    /**
+     * 获取目标类的主键。
+     * @returns {string} - 返回主键的属性名。
+     * @throws {Error} - 如果主键未定义，则抛出错误。
+     */
+    protected getPrimaryKey(): never;
+    /**
+     * 构造函数，用于初始化 CurdApi 实例。
+     * @param {Object} options - 构造函数的参数对象。
+     * @param {T} options.TargetPrototye - 目标原型，即要操作的数据类型。
+     * @param {string} options.basePath - API 的基础路径。
+     * @param {CurdApi<T, P>['treeKey']} [options.treeKey] - 树形结构的键配置。
+     * @param {P} [options.PaginationResponseClass] - 分页响应的类。
+     * @param {boolean} [options.saveWithUploadFile] - 是否使用文件上传保存数据。
+     */
+    constructor(options: {
+        TargetPrototye: T;
+        basePath: string;
+        treeKey?: CurdApi<T, P>['treeKey'];
+        PaginationResponseClass?: P;
+        saveWithUploadFile?: boolean;
+    });
+    /**
+     * 从API响应中下载文件。
+     * 这个静态方法会从API响应中提取文件名，并创建一个下载链接，然后模拟点击下载链接来下载文件。
+     * @param {AxiosResponse} response - 包含文件数据的API响应。
+     * @returns {void}
+     */
+    static downloadReponse(response: AxiosResponse): void;
+}

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

@@ -0,0 +1,55 @@
+import { httpRequest } from '../../utils';
+import { LoadUtilResponse } from '../loadUtil';
+/**
+ * 定义一个接口，描述请求工具的方法。
+ * 这个接口包含取消请求和发送请求的方法。
+ * @interface RequestUtil
+ */
+interface RequestUtil {
+    /**
+     * 定义一个方法，用于取消当前的请求。
+     * 这个方法会检查是否存在当前的请求对象，如果存在，则取消请求并将请求对象重置为 undefined。
+     * @method abort
+     * @returns {void}
+     * @description 这个方法通常在加载新的数据之前调用，以避免重复请求。
+     */
+    abort(): void;
+    /**
+     * 定义一个方法，用于发送请求并处理响应。
+     * 这个方法会发送一个 HTTP 请求，并根据请求的结果调用相应的回调函数。
+     * @method requestData
+     * @param {T} httpRequest - 一个继承自 httpRequest.HttpRequestPromise 的泛型类型，表示 HTTP 请求对象。
+     * @param {Function} [final] - 一个可选的函数，用于在请求完成后执行最终操作。
+     * @returns {Promise<T extends httpRequest.HttpRequestPromise<infer R> ? R : never>} - 一个返回值为请求结果的 Promise。
+     * @description 这个方法会在请求开始时调用 abort 方法，以取消之前的请求。
+     * @description 它会在请求过程中更新加载状态，并在请求完成后重置加载状态。
+     * @description 如果请求成功，它会返回请求的结果。
+     * @description 如果请求失败，它会抛出错误。
+     * @description 在请求完成后，它会调用 final 方法，并传递一个布尔值表示请求是否被取消。
+     */
+    requestData<T extends httpRequest.HttpRequestPromise>(httpRequest: T, final?: (isAbort: boolean) => void): Promise<T extends httpRequest.HttpRequestPromise<infer R> ? R : never>;
+}
+/**
+ * 定义一个类型别名，用于描述请求工具的响应。
+ * 这个类型别名根据泛型参数 E 的值来决定是否包含加载状态的方法。
+ * @type {RequestUtilResponse}
+ * @description 如果 E 为 true，则返回一个包含加载状态方法的对象。
+ * @description 如果 E 为 false，则返回一个只包含请求工具方法的对象。
+ */
+export type RequestUtilResponse<T extends boolean = true> = T extends false ? RequestUtil : LoadUtilResponse & RequestUtil;
+/**
+ * 定义一个自定义 Hook，用于创建请求工具。
+ * 这个 Hook 会返回一个对象，包含取消请求和发送请求的方法。
+ * @param {boolean} [endableLoadStatus] - 一个可选的布尔值，用于启用加载状态。
+ * @returns {RequestUtilResponse<E>} - 一个返回值为请求工具响应的对象。
+ * @description 这个 Hook 会根据 endableLoadStatus 的值来决定是否启用加载状态。
+ * @description 如果 endableLoadStatus 为 true，则返回一个包含加载状态方法的对象。
+ * @description 如果 endableLoadStatus 为 false，则返回一个只包含请求工具方法的对象。
+ * @description 这个 Hook 会在请求开始时调用 abort 方法，以取消之前的请求。
+ * @description 它会在请求过程中更新加载状态，并在请求完成后重置加载状态。
+ * @description 如果请求成功，它会返回请求的结果。
+ * @description 如果请求失败，它会抛出错误。
+ * @description 在请求完成后，它会调用 final 方法，并传递一个布尔值表示请求是否被取消。
+ */
+export declare const useRequestUtil: <E extends boolean = true>(endableLoadStatus?: E) => RequestUtilResponse<E>;
+export {};