zzz-pc-view 0.0.1

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

@@ -0,0 +1,752 @@
+import { httpRequest, CombineClass, CombineInstanceType, KeyMatch, WithoutFirst } from '../../utils';
+import { BasePropertyConfig, ComponentProps, EventHandlerMap, TypeWithPrototype } from '../DeclareType';
+import { FilterHandler } from '../FilterKey';
+import { EditTypeEnum, CurdApi, EditType, PaginationResponseConstructor } from './CurdApi';
+import { Config as PrimaryKeyConfig } from './../PrimaryKey';
+import { Config as NameKeyConfig } from './../NameKey';
+import { RequestUtilResponse } from './RequestUtil';
+export * from './CurdApi';
+/**
+ * 基础参数接口，用于定义通用的参数属性。
+ */
+export interface BaseParam {
+    label?: string;
+    show?: boolean;
+    orderNo?: number;
+    component?: unknown;
+    componentProps?: ComponentProps;
+    componentOn?: EventHandlerMap;
+}
+/**
+ * 表格列参数接口，继承自基础参数接口，用于定义表格列的特定参数。
+ */
+export interface TableColumnParam extends BaseParam {
+    colProps?: ComponentProps;
+}
+/**
+ * 表单项参数接口，继承自基础参数接口，用于定义表单项的特定参数。
+ */
+export interface FormItemParam extends BaseParam {
+    formItemProps?: ComponentProps;
+    stepIndex?: number;
+    rowGroup?: string;
+    colSpan?: number;
+}
+/**
+ * 响应参数接口，用于定义返回数据的结构。
+ */
+export interface ResponseParam {
+    label?: string;
+    tableColumn?: TableColumnParam;
+    formItem?: FormItemParam;
+}
+/**
+ * 定义一个参数接口，用于创建 CurdHandler 实例时传递参数。
+ * @template T - 对象类型，默认为 object。
+ * @param {CurdHandler<T>} this - CurdHandler 实例。
+ * @returns {ResponseParam} - 返回一个 ResponseParam 对象。
+ */
+export interface Param<T extends object = object> {
+    (this: CurdHandler<T>): ResponseParam;
+}
+/**
+ * 定义一个配置接口，继承自 BasePropertyConfig。
+ * @template T - 对象类型，默认为 object。
+ * @extends {BasePropertyConfig} - 继承自 BasePropertyConfig。
+ * @property {Param<T>} creator - 一个函数，用于创建 ResponseParam 对象。
+ */
+export interface Config<T extends object = object> extends BasePropertyConfig {
+    creator: Param<T>;
+}
+/**
+ * 定义一个接口，用于描述 CURD 操作的配置。
+ * 该接口继承自 BasePropertyConfig 并包含 Param 函数的返回类型。
+ * @template T - 对象类型，默认为 object。
+ * @extends {BasePropertyConfig} - 继承自 BasePropertyConfig。
+ * @extends {ReturnType<Param>} - 包含 Param 函数的返回类型。
+ */
+interface HandlerConfig extends BasePropertyConfig, ReturnType<Param> {
+}
+/**
+ * 定义一个分页请求的接口。
+ * @interface PaginationRequest
+ * @property {number} currentPage - 当前页码。
+ * @property {number} pageSize - 每页显示的记录数。
+ */
+export interface PaginationRequest {
+    currentPage: number;
+    pageSize: number;
+}
+/**
+ * 定义一个接口，用于描述组件的参数。
+ * @interface ComponentParam
+ * @property {ComponentProps} [props] - 组件的属性。
+ * @property {EventHandlerMap} [on] - 组件的事件处理函数。
+ */
+interface ComponentParam {
+    props?: ComponentProps;
+    on?: EventHandlerMap;
+}
+/**
+ * 定义一个接口，用于描述表格的参数。
+ * 该接口继承自 ComponentParam，并包含一个可选的 showIndex 属性，用于控制是否显示行索引，
+ * 以及一个可选的 indexColWidth 属性，用于设置行索引列的宽度。
+ * @interface TableParam
+ * @extends {ComponentParam} - 继承自 ComponentParam。
+ * @property {boolean} [showIndex] - 可选的属性，用于控制是否显示行索引。
+ * @property {number | string} [indexColWidth] - 可选的属性，用于设置行索引列的宽度。
+ */
+interface TableParam extends ComponentParam {
+    showIndex?: boolean;
+    indexColWidth?: number | string;
+}
+/**
+ * 定义一个接口，用于描述表单的步骤。
+ * @interface FormStep
+ * @property {string} [label] - 步骤的标签，用于显示在步骤标题处。
+ * @property {string} [desc] - 步骤的描述，用于显示在步骤标题下方。
+ */
+interface FormStep {
+    label?: string;
+    desc?: string;
+}
+/**
+ * 定义一个接口，用于描述表单的参数。
+ * 该接口继承自 ComponentParam，并包含一个可选的 steps 属性，用于定义表单的步骤。
+ * @interface FormParam
+ * @extends {ComponentParam} - 继承自 ComponentParam。
+ * @property {FormStep[]} [steps] - 表单的步骤，每个步骤包含一个标签和描述。
+ */
+interface FormParam extends ComponentParam {
+    steps?: FormStep[];
+}
+/**
+ * 定义一个接口，用于描述 CURD 操作的参数。
+ * 该接口包含一个标签、一个 CURD API 实例、一个可选的分页请求和一个子键。
+ * 它还可以包含一个可选的组件创建器函数，用于创建表格和表单的参数。
+ * @template T - 对象类型，默认为 object。
+ * @interface CurdHandlerParam
+ * @property {string} label - CURD 操作的标签。
+ * @property {CurdApi<T>} api - CURD API 实例。
+ * @property {PaginationRequest} [pagination] - 可选的分页请求。
+ * @property {(this: CurdHandler<T>) => { tableParam?: ComponentParam; formParam?: FormParam }} [componentCreator] - 可选的组件创建器函数，用于创建表格和表单的参数。
+ */
+export interface CurdHandlerParam<T extends object = object> {
+    label: string;
+    api: CurdApi<T>;
+    pagination?: PaginationRequest;
+    componentCreator?(this: CurdHandler<T>): {
+        tableParam?: TableParam;
+        formParam?: FormParam;
+    };
+}
+/**
+ * 定义一个唯一的符号作为键，用于标识类级别的 CURD 配置。
+ * 这个键将用于在类的原型上存储和检索 CURD 配置。
+ */
+declare const classCurdKey: unique symbol;
+/**
+ * 定义一个枚举类型，用于表示不同的 CURD（创建、读取、更新、删除）操作类型。
+ * 这个枚举类型将用于在组件中区分不同的操作类型，并根据类型执行相应的逻辑。
+ * @enum {number}
+ * @description 这个枚举类型是数字类型，每个成员都有一个对应的整数值。
+ * @description 它包含了 FILTER、CREATE 和 CONTINUE_CREATE 三个成员，分别表示过滤、创建和继续创建操作。
+ */
+export declare enum CreateTypeEnum {
+    /**
+     * 表示过滤操作，用于查询数据记录。
+     * @type {number}
+     * @description 这个成员的值是 1。
+     * @description 它通常用于在表格中显示过滤条件，或者在表单中显示查询条件。
+     */
+    FILTER = 1,
+    /**
+     * 表示创建操作，用于创建新的数据记录。
+     * @type {number}
+     * @description 这个成员的值是 2。
+     * @description 它通常用于在表单中显示创建表单，或者在模态框中显示创建对话框。
+     */
+    CREATE = 2,
+    /**
+     * 表示继续创建操作，用于在创建操作完成后继续创建新的数据记录。
+     * @type {number}
+     * @description 这个成员的值是 6。
+     * @description 它通常用于在创建表单中显示继续创建按钮，或者在模态框中显示继续创建对话框。
+     */
+    CONTINUE_CREATE = 6
+}
+/**
+ * 定义一个接口，用于描述 CURD 模型的构造函数。
+ * 该接口继承自 TypeWithPrototype 和 CombineClass，并定义了一个新的构造函数签名。
+ * @template T - 对象类型，默认为 object。
+ * @interface CurdModelConstructor
+ * @extends {TypeWithPrototype} - 继承自 TypeWithPrototype。
+ * @extends {CombineClass} - 继承自 CombineClass。
+ * @property {new (createType: CreateTypeEnum, ...args: any[]): T} - 一个新的构造函数，接受一个 CreateTypeEnum 类型的参数和任意数量的参数，并返回一个 T 类型的实例。
+ * @property {CurdHandler<T>} [classCurdKey] - 一个可选的属性，用于存储 CurdHandler 实例。
+ */
+export interface CurdModelConstructor<T extends object = object> extends TypeWithPrototype, CombineClass {
+    new (createType: CreateTypeEnum, ...args: any[]): T;
+    [classCurdKey]?: CurdHandler<T>;
+}
+export declare abstract class CurdHandler<T extends object = object> extends FilterHandler<T> {
+    readonly curdTargetPrototype: T;
+    /**
+     * 定义一个只读属性，用于存储 CURD 操作的目标模型构造函数。
+     * 这个属性将用于在组件中创建和操作数据记录。
+     * @type {CurdModelConstructor<T>}
+     * @description 这个属性是只读的，意味着它不能被直接修改。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    protected readonly CurdTarget: CurdModelConstructor<T>;
+    /**
+     * 定义一个只读属性，用于存储表单项的标签。
+     * 这个属性将用于在组件中显示表单项的标签。
+     * @type {string}
+     * @description 这个属性是只读的，意味着它不能被直接修改。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    readonly label: string;
+    /**
+     * 创建一个浅引用，用于存储 CURD 操作的配置。
+     * 这个引用将用于在组件中存储和更新 CURD 配置。
+     * @type {shallowRef<HandlerConfig[]>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly curdConfigsRef: import('vue').ShallowRef<HandlerConfig[] | undefined, HandlerConfig[] | undefined>;
+    /**
+     * 根据指定的键获取并返回配置项数组。
+     * 这个方法从 curdConfigsRef 中获取配置项，并根据 orderNo 对其进行排序。
+     * 如果配置项中缺少 label 属性，它会尝试从父配置中继承。
+     *
+     * @template K - 一个泛型类型，用于匹配 HandlerConfig 中的键，这些键包含 label 和 orderNo 属性。
+     * @param {K} key - 要获取配置项的键。
+     * @returns {Required<HandlerConfig>[K][]} - 一个包含排序后的配置项的数组。
+     */
+    protected getItemConfigs<K extends KeyMatch<Required<HandlerConfig>, BaseParam>>(key: K): (Required<HandlerConfig>[K] & {
+        propertyKey: KeyMatch<T, unknown>;
+    })[];
+    /**
+     * 创建一个计算属性，用于获取并返回表格列的配置项数组。
+     * 这个计算属性依赖于 getItemConfigs 方法，它会根据 'tableColumn' 键获取配置项，并返回一个只读的数组。
+     * @type {ComputedRef<Required<HandlerConfig>['tableColumn'][]>}
+     * @description 这个计算属性是只读的，意味着它不能被直接修改。
+     * @description 它会在依赖项发生变化时自动更新。
+     */
+    protected readonly tableColumnsComputed: import('vue').ComputedRef<(TableColumnParam & {
+        propertyKey: KeyMatch<T, unknown>;
+    })[]>;
+    /**
+     * 创建一个计算属性，用于获取并返回显示的表格列的配置项数组。
+     * 这个计算属性依赖于 tableColumnsComputed 计算属性，它会过滤掉 show 属性为 false 的配置项，并返回一个只读的数组。
+     * @type {ComputedRef<Required<HandlerConfig>['tableColumn'][]>}
+     * @description 这个计算属性是只读的，意味着它不能被直接修改。
+     * @description 它会在依赖项发生变化时自动更新。
+     */
+    protected readonly displayTableColumnsComputed: import('vue').ComputedRef<(TableColumnParam & {
+        propertyKey: KeyMatch<T, unknown>;
+    })[]>;
+    /**
+     * 获取显示的表格列的配置项数组。
+     * 这个方法返回 displayTableColumnsComputed 计算属性的值，它包含了所有 show 属性不为 false 的表格列配置项。
+     * @returns {Required<HandlerConfig>['tableColumn'][]} - 一个包含显示的表格列配置项的数组。
+     */
+    get displayTableColumns(): (TableColumnParam & {
+        propertyKey: KeyMatch<T, unknown>;
+    })[];
+    /**
+     * 创建一个计算属性，用于获取并返回表单项的配置项数组。
+     * 这个计算属性依赖于 getItemConfigs 方法，它会根据 'formItem' 键获取配置项，并返回一个只读的数组。
+     * @type {ComputedRef<Required<HandlerConfig>['formItem'][]>}
+     * @description 这个计算属性是只读的，意味着它不能被直接修改。
+     * @description 它会在依赖项发生变化时自动更新。
+     */
+    protected readonly formItemsComputed: import('vue').ComputedRef<(FormItemParam & {
+        propertyKey: KeyMatch<T, unknown>;
+    })[]>;
+    /**
+     * 创建一个计算属性，用于获取并返回显示的表单项的配置项数组。
+     * 这个计算属性依赖于 formItemsComputed 计算属性，它会过滤掉 show 属性为 false 的配置项，并返回一个只读的数组。
+     * @type {ComputedRef<Required<HandlerConfig>['formItem'][]>}
+     * @description 这个计算属性是只读的，意味着它不能被直接修改。
+     * @description 它会在依赖项发生变化时自动更新。
+     */
+    protected readonly displayFormItemsComputed: import('vue').ComputedRef<(FormItemParam & {
+        propertyKey: KeyMatch<T, unknown>;
+    })[]>;
+    /**
+     * 创建一个计算属性，用于获取并返回显示的表单项的分组配置。
+     * 这个计算属性依赖于 displayFormItemsComputed 计算属性，它会根据 stepIndex 和 steps 配置对表单项进行分组，并返回一个只读的数组。
+     * @type {ComputedRef<{ label?: string; desc?: string; index: number; formItems: FormItemParam[] }[]>}
+     * @description 这个计算属性是只读的，意味着它不能被直接修改。
+     * @description 它会在依赖项发生变化时自动更新。
+     */
+    protected readonly displayStepFormItemsGroupComputed: import('vue').ComputedRef<{
+        label?: string;
+        desc?: string;
+        index: number;
+        formItems: FormItemParam[];
+    }[]>;
+    /**
+     * 获取显示的表单项的分组配置。
+     * 这个方法返回 displayStepFormItemsGroupComputed 计算属性的值，它包含了所有 show 属性不为 false 的表单项的分组配置。
+     * @returns {{ label?: string; desc?: string; index: number; formItems: FormItemParam[] }[]} - 一个包含表单项分组配置的数组。
+     */
+    get displayStepFormItemsGroup(): {
+        label?: string;
+        desc?: string;
+        index: number;
+        formItems: FormItemParam[];
+    }[];
+    /**
+     * 定义一个只读属性，用于存储 CURD 操作的 API 实例。
+     * 这个属性将用于在组件中执行 CURD 操作。
+     * @type {CurdApi<T>}
+     * @description 这个属性是只读的，意味着它不能被直接修改。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    protected readonly api: CurdApi<T, PaginationResponseConstructor<T>>;
+    /**
+     * 定义一个可选的只读属性，用于存储分页配置。
+     * 这个属性将用于在组件中控制分页行为。
+     * @type {CurdHandlerParam<T>['pagination']}
+     * @description 这个属性是可选的，意味着它可以不存在。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    readonly pagination?: CurdHandlerParam<T>['pagination'];
+    /**
+     * 重置分页设置。
+     * 这个方法用于将分页的当前页码重置为第一页。
+     * @description 这个方法通常在刷新列表数据或进行新的搜索时调用。
+     */
+    resetPagination(): void;
+    /**
+     * 创建一个浅引用，用于存储表格组件的参数。
+     * 这个引用将用于在组件中存储和更新表格组件的参数。
+     * @type {shallowRef<TableParam>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly tableParamRef: import('vue').ShallowRef<TableParam | undefined, TableParam | undefined>;
+    /**
+     * 获取表格组件的参数。
+     * 这个方法返回 tableParamRef 引用的值，它包含了表格组件的参数。
+     * @returns {TableParam} - 表格组件的参数。
+     */
+    get tableParam(): TableParam | undefined;
+    /**
+     * 创建一个浅引用，用于存储表单组件的参数。
+     * 这个引用将用于在组件中存储和更新表单组件的参数。
+     * @type {shallowRef<FormParam>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly formParamRef: import('vue').ShallowRef<FormParam | undefined, FormParam | undefined>;
+    /**
+     * 获取表单参数。
+     * 这个方法返回 formParamRef 引用的值，它包含了表单组件的参数。
+     * @returns {FormParam} - 表单组件的参数。
+     */
+    get formParam(): FormParam | undefined;
+    /**
+     * 定义一个可选的只读属性，用于存储主键配置。
+     * 这个属性将用于在组件中识别和操作数据记录。
+     * @type {PrimaryKeyConfig<T>}
+     * @description 这个属性是可选的，意味着它可以不存在。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    protected readonly primaryKeyConfig?: PrimaryKeyConfig<T>;
+    /**
+     * 获取主键配置。
+     * 这个方法返回 primaryKeyConfig 属性的值，它包含了主键的配置信息。
+     * 如果 primaryKeyConfig 不存在，则返回 undefined。
+     * @returns {PrimaryKeyConfig<T> | undefined} - 主键配置，如果不存在则返回 undefined。
+     */
+    getPrimaryKeyConfig(): PrimaryKeyConfig<T> | undefined;
+    /**
+     * 定义一个可选的只读属性，用于存储名称键配置。
+     * 这个属性将用于在组件中显示和操作数据记录的名称。
+     * @type {NameKeyConfig<T>}
+     * @description 这个属性是可选的，意味着它可以不存在。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    protected readonly nameKeyConfig?: NameKeyConfig<T>;
+    /**
+     * 获取数据的名称。
+     * 这个方法用于根据配置的名称键获取数据对象中的名称。
+     * 如果没有配置名称键，则返回一个空字符串。
+     *
+     * @param {T} data - 包含名称的对象。
+     * @returns {string} - 数据的名称，如果没有配置名称键，则返回一个空字符串。
+     */
+    getDataName(data: T): "" | T[KeyMatch<T, import('../../utils').KeyValType>];
+    /**
+     * 获取名称键配置。
+     * 这个方法返回 nameKeyConfig 属性的值，它包含了名称键的配置信息。
+     * 如果 nameKeyConfig 不存在，则返回 undefined。
+     * @returns {NameKeyConfig<T> | undefined} - 名称键配置，如果不存在则返回 undefined。
+     */
+    getNameKeyConfig(): NameKeyConfig<T> | undefined;
+    /**
+     * 定义一个只读属性，用于存储请求工具的响应。
+     * 这个属性将用于在组件中处理请求的加载状态和取消请求。
+     * @type {RequestUtilResponse}
+     * @description 这个属性是只读的，意味着它不能被直接修改。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    protected readonly listRequestUtil: RequestUtilResponse;
+    /**
+     * 获取列表数据的加载状态。
+     * 这个方法返回 listRequestUtil.loadStatus 的值，它表示列表数据是否正在加载。
+     * @returns {boolean} - 列表数据的加载状态。
+     */
+    get listLoadStatus(): boolean;
+    /**
+     * 创建一个浅引用，用于存储搜索查询参数。
+     * 这个引用将用于在组件中存储和更新搜索查询参数。
+     * @type {shallowRef<T>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly searchQueryRef: import('vue').ShallowRef<T | undefined, T | undefined>;
+    /**
+     * 获取搜索查询参数。
+     * 这个方法返回 searchQueryRef 引用的值，它表示当前的搜索查询参数。
+     * @returns {T} - 当前的搜索查询参数。
+     */
+    get searchQuery(): T | undefined;
+    /**
+     * 设置搜索查询参数。
+     * 这个方法用于更新 searchQueryRef 引用的值，从而更新搜索查询参数。
+     * 它会将当前的查询参数转换为 JSON 字符串，然后再解析回对象，以确保数据的一致性。
+     * 最后，它会将解析后的对象绑定到 FilterTarget 上，并将结果赋值给 searchQueryRef。
+     */
+    protected setSearchQuery(): void;
+    /**
+     * 创建一个浅引用，用于存储列表数据。
+     * 这个引用将用于在组件中存储和更新列表数据。
+     * @type {shallowRef<T[]>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly listRef: import('vue').ShallowRef<T[], T[]>;
+    /**
+     * 定义一个计算属性，用于获取当前显示的列表数据。
+     * 这个计算属性会根据分页配置，从列表数据中截取当前页的数据。
+     * @returns {T[]} - 当前显示的列表数据。
+     * @description 这个计算属性会在分页配置或列表数据发生变化时重新计算。
+     * @description 它会根据当前页码和每页显示数量，从列表数据中截取相应的数据。
+     * @description 如果没有分页配置，则返回全部列表数据。
+     */
+    protected readonly displayListComputed: import('vue').ComputedRef<T[]>;
+    /**
+     * 获取当前显示的列表数据。
+     * 这个方法返回 displayListComputed 计算属性的值，它表示当前显示的列表数据。
+     * @returns {T[]} - 当前显示的列表数据。
+     */
+    get displayList(): T[];
+    /**
+     * 创建一个浅引用，用于存储列表数据的总数。
+     * 这个引用将用于在组件中存储和更新列表数据的总数。
+     * @type {shallowRef<number>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly totalRef: import('vue').ShallowRef<number, number>;
+    /**
+     * 设置列表数据和总数。
+     * 这个方法用于更新 listRef 和 totalRef 引用的值，从而更新列表数据和总数。
+     * @param {T[]} list - 要设置的列表数据。
+     * @param {number} total - 列表数据的总数。
+     */
+    protected setList(list: T[], total: number): void;
+    /**
+     * 加载列表数据。
+     * 这个方法用于从API加载列表数据，并更新列表和总数的引用。
+     * @description 这个方法通常在组件初始化或用户触发刷新操作时调用。
+     * @description 它会根据API是否支持服务器端分页，调用不同的方法来获取数据。
+     * @description 如果API支持服务器端分页，则调用getListByPage方法获取分页数据；否则，调用getList方法获取全部数据。
+     * @description 获取到数据后，会调用setList方法更新列表和总数的引用。
+     * @returns {Promise<void>} - 返回一个Promise，表示加载操作的结果。
+     */
+    protected loadList(): Promise<void>;
+    /**
+     * 获取列表数据。
+     * 这个方法用于从API获取列表数据，并更新列表和总数的引用。
+     * @description 这个方法通常在组件初始化或用户触发刷新操作时调用。
+     * @description 它会先重置分页设置，然后调用 loadList 方法来加载数据。
+     */
+    protected getList(): void;
+    /**
+     * 当查询验证成功时调用的方法。
+     * 这个方法会检查表格列是否为空，如果不为空，则调用 getList 方法获取列表数据。
+     * @description 这个方法通常在查询验证成功后调用。
+     * @description 它会检查表格列是否为空，如果为空，则不执行任何操作。
+     * @description 如果表格列不为空，则调用 getList 方法获取列表数据。
+     * @returns {void}
+     */
+    protected onValidateQuerySuccess(): void;
+    /**
+     * 定义一个只读属性，用于处理当前页码改变事件。
+     * 这个属性是一个函数，它会在当前页码改变时被调用。
+     * 如果 API 支持服务器端分页，则调用 loadList 方法重新加载列表数据。
+     * @description 这个属性通常用于监听分页组件的页码改变事件。
+     * @returns {void}
+     */
+    readonly onCurrentPageChange: () => void;
+    /**
+     * 定义一个只读属性，用于处理每页显示数量改变事件。
+     * 这个属性是一个函数，它会在每页显示数量改变时被调用。
+     * 如果 API 支持服务器端分页，则调用 getList 方法重新加载列表数据；否则，重置分页设置。
+     * @description 这个属性通常用于监听分页组件的每页显示数量改变事件。
+     * @returns {void}
+     */
+    readonly onPageSizeChange: () => void;
+    /**
+     * 定义一个抽象方法，用于确认删除操作。
+     * 这个方法会在删除数据之前被调用，用于确认用户是否真的要删除数据。
+     * @param {T} data - 要删除的数据。
+     * @returns {Promise<any>} - 返回一个Promise，表示确认删除操作的结果。
+     */
+    protected abstract confirmDelete(data: T): Promise<any>;
+    /**
+     * 定义一个抽象方法，用于在删除数据成功后执行的操作。
+     * 这个方法会在数据成功删除后被调用，用于执行一些后续操作，例如提示用户删除成功、更新UI等。
+     * @description 这个方法通常在数据删除成功后调用。
+     * @description 子类必须实现这个方法，否则会抛出错误。
+     * @param {T} data - 被删除的数据。
+     * @returns {void}
+     */
+    protected abstract onDeleteSuccess(data: T): void;
+    /**
+     * 删除指定的数据。
+     * 这个方法会调用 confirmDelete 方法来确认删除操作，然后从 API 删除数据，并在删除成功后重新加载列表数据。
+     * @param {T} data - 要删除的数据。
+     * @returns {void}
+     */
+    delete(data: T): void;
+    /**
+     * 导出数据。
+     * 这个方法调用API的导出方法，并传递当前的查询参数。
+     * @returns {Promise<any>} - 返回一个Promise，表示导出操作的结果。
+     */
+    export(): httpRequest.HttpRequestPromise<void>;
+    /**
+     * 创建一个浅引用，用于存储当前步骤的索引。
+     * 这个引用将用于在组件中存储和更新当前步骤的索引。
+     * @type {shallowRef<number>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected formStepIndexRef: import('vue').ShallowRef<number, number>;
+    /**
+     * 获取当前步骤的索引。
+     * 这个方法返回 formStepIndexRef 引用的值，它表示当前步骤的索引。
+     * @returns {number} - 当前步骤的索引。
+     */
+    get formStepIndex(): number;
+    /**
+     * 设置当前步骤的索引。
+     * 这个方法用于更新当前步骤的索引，并确保其值在有效范围内。
+     * @param {number} formStepIndex - 要设置的步骤索引。
+     * @description 这个方法会将 formStepIndexRef 引用的值更新为传入的 formStepIndex。
+     * @description 它会确保 formStepIndex 的值在 0 和 displayStepFormItemsGroup.length - 1 之间，以防止越界。
+     */
+    set formStepIndex(formStepIndex: number);
+    /**
+     * 创建一个浅引用，用于存储编辑类型。
+     * 这个引用将用于在组件中存储和更新编辑类型。
+     * @type {shallowRef<EditType>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly editTypeRef: import('vue').ShallowRef<EditType, EditType>;
+    /**
+     * 获取当前编辑类型。
+     * 这个方法返回 editTypeRef 引用的值，它表示当前的编辑类型。
+     * @returns {EditType} - 当前的编辑类型。
+     */
+    get editType(): EditType;
+    /**
+     * 创建一个浅引用，用于存储编辑器的可见性状态。
+     * 这个引用将用于在组件中存储和更新编辑器的可见性。
+     * @type {shallowRef<boolean>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly editorVisibleRef: import('vue').ShallowRef<boolean, boolean>;
+    /**
+     * 获取编辑器的可见性状态。
+     * 这个方法返回 editorVisibleRef 引用的值，它表示编辑器是否可见。
+     * @returns {boolean} - 编辑器的可见性状态。
+     */
+    get editorVisible(): boolean;
+    /**
+     * 设置编辑器的可见性状态。
+     * 这个方法用于更新编辑器的可见性，并在关闭编辑器时执行一些清理操作。
+     * @param {boolean} editorVisible - 编辑器的可见性状态。
+     * @description 这个方法会更新 editorVisibleRef 引用的值，从而更新编辑器的可见性。
+     * @description 如果编辑器正在关闭（editorVisible 为 false），它会取消正在进行的编辑器数据请求，并调用 afterCloseEditor 方法。
+     */
+    set editorVisible(editorVisible: boolean);
+    /**
+     * 在关闭编辑器后执行的抽象方法。
+     * 这个方法会在编辑器关闭后被调用，用于执行一些清理操作。
+     * @description 这个方法通常在编辑器关闭时调用。
+     * @description 子类必须实现这个方法，否则会抛出错误。
+     * @returns {void}
+     */
+    protected abstract afterCloseEditor(): void;
+    /**
+     * 定义一个只读属性，用于存储编辑器数据的请求工具响应。
+     * 这个属性将用于在组件中处理编辑器数据请求的加载状态和取消请求。
+     * @type {RequestUtilResponse}
+     * @description 这个属性是只读的，意味着它不能被直接修改。
+     * @description 它会在组件初始化时被设置，并且在组件的整个生命周期中保持不变。
+     */
+    protected readonly editorDataRequestUtil: RequestUtilResponse;
+    /**
+     * 获取编辑器数据的加载状态。
+     * 这个方法返回 editorDataRequestUtil.loadStatus 的值，它表示编辑器数据是否正在加载。
+     * @returns {boolean} - 编辑器数据的加载状态。
+     */
+    get editorDataLoadStatus(): boolean;
+    /**
+     * 创建一个浅引用，用于存储编辑器数据。
+     * 这个引用将用于在组件中存储和更新编辑器数据。
+     * @type {shallowRef<T>}
+     * @description 这个引用是浅的，意味着它不会递归地观察嵌套对象的变化。
+     * @description 这对于性能优化很重要，因为它避免了不必要的更新。
+     */
+    protected readonly editorDataRef: import('vue').ShallowRef<T | undefined, T | undefined>;
+    /**
+     * 获取编辑器数据。
+     * 这个方法返回 editorDataRef 引用的值，它包含了编辑器当前的数据。
+     * @returns {T | undefined} - 编辑器数据，如果不存在则返回 undefined。
+     */
+    get editorData(): T | undefined;
+    /**
+     * 设置编辑器的数据并准备好后执行的操作。
+     * 这个方法用于更新编辑器数据的引用，并在数据准备好后执行一些后续操作。
+     * @param {T} editorData - 要设置的编辑器数据。
+     * @description 这个方法会更新 editorDataRef 引用的值，从而更新编辑器的数据。
+     * @description 在设置数据后，它会调用 afterEditorDataReady 方法，执行一些后续操作，例如初始化编辑器、绑定事件等。
+     */
+    protected setEditorData(editorData: T): void;
+    /**
+     * 定义一个抽象方法，用于在编辑器数据准备好后执行的操作。
+     * 这个方法会在编辑器数据加载完成后被调用，用于执行一些后续操作，例如初始化编辑器、绑定事件等。
+     * @description 这个方法通常在编辑器数据加载完成后调用。
+     * @description 子类必须实现这个方法，否则会抛出错误。
+     * @returns {void}
+     */
+    protected abstract afterEditorDataReady(): void;
+    /**
+     * 打开编辑器并设置编辑类型和数据。
+     * 这个方法会根据传入的编辑类型和数据，设置当前的编辑类型、步骤索引和编辑器的可见性。
+     * 如果编辑类型是更新，则会通过API获取数据并设置为编辑器的数据。
+     * @param {EditTypeEnum} editTypeId - 编辑类型的枚举值。
+     * @param {T} data - 要编辑的数据。
+     * @returns {void}
+     */
+    openEditor(editTypeId: EditTypeEnum, data: T): Promise<void>;
+    /**
+     * 关闭编辑器。
+     * 这个方法会将编辑器的可见性设置为 false，从而关闭编辑器。
+     * @returns {void}
+     */
+    closeEditor(): void;
+    protected saveEditorDataRequestUtil: RequestUtilResponse;
+    /**
+     * 抽象方法，用于验证编辑器数据的有效性。
+     * 这个方法会在打开编辑器之前被调用，用于执行一些验证逻辑。
+     * @description 这个方法通常在打开编辑器之前调用。
+     * @description 它会返回一个 Promise，如果验证通过，则继续打开编辑器；否则，抛出错误。
+     * @returns {Promise<any>} - 返回一个 Promise，表示验证的结果。
+     */
+    protected abstract validEditorData(): Promise<any>;
+    /**
+     * 定义一个抽象方法，用于在保存编辑器数据成功后执行的操作。
+     * 这个方法会在编辑器数据成功保存到服务器后被调用，用于执行一些后续操作，例如提示用户保存成功、更新UI等。
+     * @description 这个方法通常在编辑器数据保存成功后调用。
+     * @description 子类必须实现这个方法，否则会抛出错误。
+     * @param {T} data - 保存成功的编辑器数据。
+     * @returns {void}
+     */
+    protected abstract onSaveEditorDataSuccess(data: T): void;
+    /**
+     * 保存编辑器数据并执行回调函数。
+     * 这个方法会验证编辑器数据的有效性，然后将数据发送到服务器进行保存。
+     * 如果保存成功，它会重新加载列表数据，并执行传入的回调函数（如果有）。
+     * @param {Function} [callback] - 可选的回调函数，在数据保存成功后执行。
+     * @returns {void}
+     */
+    saveEditorData(callback?: (data: T) => void): void;
+    /**
+     * 保存编辑器数据并继续创建。
+     * 这个方法会将当前步骤索引重置为0，然后调用saveEditorData方法保存编辑器数据。
+     * 在保存成功后，它会创建一个新的编辑器数据实例，并将其设置为编辑器的数据。
+     * @returns {void}
+     */
+    editorDataSaveAndContinue(): void;
+    /**
+     * 保存编辑器数据并关闭编辑器。
+     * 这个方法会调用 saveEditorData 方法来保存当前的编辑器数据，然后将编辑器的可见性设置为 false，从而关闭编辑器。
+     * @returns {void}
+     */
+    editorDataSaveAndClose(): void;
+    /**
+     * 在初始化 CURD 配置后执行的钩子函数。
+     * 这个抽象方法会在初始化 CURD 配置后调用，用于执行一些后续操作，例如设置默认值、绑定事件等。
+     * @description 这个方法通常在组件初始化时调用。
+     * @description 子类必须实现这个方法，否则会抛出错误。
+     * @returns {void}
+     */
+    protected abstract afterInitCurdConfigs(): void;
+    /**
+     * 抽象方法，用于在组件销毁前执行清理操作。
+     * 这个方法会在组件销毁前被调用，用于执行一些清理逻辑，例如取消请求、清除定时器等。
+     * @description 这个方法通常在组件销毁时调用。
+     * @description 子类必须实现这个方法，否则会抛出错误。
+     * @returns {void}
+     */
+    protected abstract onBeforeUnmount(): void;
+    /**
+     * 创建一个新的CurdHandler实例。
+     * 这个构造函数初始化CurdHandler实例，并设置必要的属性和配置。
+     * @param {T} curdTargetPrototype - 目标对象的原型。
+     * @param {CurdHandlerParam<T>} param - 包含API和分页配置的参数对象。
+     * @param {...WithoutFirst<ConstructorParameters<typeof FilterHandler<T>>>} args - 传递给父类构造函数的参数。
+     */
+    constructor(curdTargetPrototype: T, param: CurdHandlerParam<T>, ...args: WithoutFirst<ConstructorParameters<typeof FilterHandler<T>>>);
+    /**
+     * 根据目标对象的原型获取对应的 CURD 实例。
+     * 这个静态方法会通过目标对象的构造函数来获取其原型上的 CURD 实例。
+     * @param {T} curdTargetPrototype - 目标对象的原型。
+     * @returns {CurdHandler<T> | undefined} - 返回 CURD 实例，如果不存在则返回 undefined。
+     * @template T - 目标对象的类型。
+     */
+    static getCurdInstance<T extends object>(curdTargetPrototype: T): CurdHandler<T> | undefined;
+}
+/**
+ * 定义一个装饰器，用于设置对象原型的配置。
+ * 这个装饰器会调用 setConfigsByPrototype 函数来设置配置。
+ * @param {Param<T>} param - 配置参数。
+ * @returns {(target: T, propertyKey: string | symbol) => void} - 装饰器函数。
+ */
+export declare const decorator: <T extends object>(param: Param<T>) => ((target: T, propertyKey: string | symbol) => void);
+/**
+ * 根据对象的原型获取配置。
+ * 这个函数会调用 getConfigByPrototypeAndKey 函数来获取配置，并将结果转换为 Config<T>[] 类型。
+ * @param {T} target - 要获取配置的对象的原型。
+ * @returns {undefined | Config<T>[]} - 返回一个 Config<T> 数组，如果没有找到配置则返回 undefined。
+ */
+export declare const getConfigsByPrototype: <T extends object>(target: T) => undefined | Config<T>[];
+/**
+ * 根据类获取配置。
+ * 这个函数会调用 getConfigsByPrototype 函数来获取类的原型的配置，并将结果转换为 Config<CombineInstanceType<T>> 类型。
+ * @param {T} Class - 要获取配置的类。
+ * @returns {undefined | Config<CombineInstanceType<T>>} - 返回一个 Config<CombineInstanceType<T>> 数组，如果没有找到配置则返回 undefined。
+ */
+export declare const getConfigsByClass: <T extends CombineClass>(Class: T) => undefined | Config<CombineInstanceType<T>>;