@dazhicheng/ui 1.6.19 → 1.6.20

package/dist/components/tt-form/src/types.d.ts

@@ -134,12 +134,19 @@ export interface ArraySchemaContext {
 export type FormActions = FormContext<GenericObject> & {
     arrayAction?: FormArrayActions;
 };
+/**
+ * 表单值写入入参。
+ *
+ * 已声明的字段按 `TValues` 校验类型，同时允许写入嵌套数组路径（如 `list.0.name`）这类
+ * 不在 `TValues` 里的键，与 `setValues` 的运行时口径一致。
+ */
+export type FormValuesInput<TValues extends Record<string, any> = Record<string, any>> = Partial<TValues> & Record<string, unknown>;
 /** 表单 schema 回调的公共参数类型 */
-export type CustomRenderType<TValues extends Record<string, any> = Record<string, any>> = ((value: TValues, formApi: FormApi) => Component | VNodeChild) | string;
+export type CustomRenderType<TValues extends Record<string, any> = Record<string, any>> = ((value: TValues, formApi: ExtendedFormApi<TValues>) => Component | VNodeChild) | string;
 export type FormSchemaRuleType = "required" | "selectRequired" | null | (Record<never, never> & string) | ZodTypeAny;
-export type FormItemDependenciesCondition<TResult = boolean | PromiseLike<boolean>, TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: FormApi) => TResult;
-export type FormItemDependenciesConditionWithRules<TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: FormApi) => FormSchemaRuleType | PromiseLike<FormSchemaRuleType>;
-export type FormItemDependenciesConditionWithProps<TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: FormApi) => MaybeComponentProps | PromiseLike<MaybeComponentProps>;
+export type FormItemDependenciesCondition<TResult = boolean | PromiseLike<boolean>, TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: ExtendedFormApi<TValues>) => TResult;
+export type FormItemDependenciesConditionWithRules<TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: ExtendedFormApi<TValues>) => FormSchemaRuleType | PromiseLike<FormSchemaRuleType>;
+export type FormItemDependenciesConditionWithProps<TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: ExtendedFormApi<TValues>) => MaybeComponentProps | PromiseLike<MaybeComponentProps>;
 export interface FormItemDependencies<TValues extends Record<string, any> = Record<string, any>> {
     /**
      * 组件参数
@@ -190,7 +197,7 @@ export interface FormItemDependencies<TValues extends Record<string, any> = Reco
  * - 允许声明 `triggerFields` 作为依赖触发源
  */
 export type ArrayRegisterDependencies<TValues extends Record<string, any> = Record<string, any>> = Pick<FormItemDependencies<TValues>, "if" | "show" | "rules" | "disabled" | "triggerFields">;
-export type ComponentProps<TValues extends Record<string, any> = Record<string, any>> = ((value: TValues, formApi: FormApi) => MaybeComponentProps) | MaybeComponentProps;
+export type ComponentProps<TValues extends Record<string, any> = Record<string, any>> = ((value: TValues, formApi: ExtendedFormApi<TValues>) => MaybeComponentProps) | MaybeComponentProps;
 export interface FormCommonConfig<TValues extends Record<string, any> = Record<string, any>> {
     /**
      * 在Label后显示一个冒号
@@ -262,9 +269,9 @@ export interface FormCommonConfig<TValues extends Record<string, any> = Record<s
      */
     wrapperClass?: string;
 }
-export type RenderComponentContentType<TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: FormApi) => Record<string, any>;
-export type HandleSubmitFn = (values: Record<string, any>) => Promise<void> | void;
-export type HandleResetFn = (values: Record<string, any>) => Promise<void> | void;
+export type RenderComponentContentType<TValues extends Record<string, any> = Record<string, any>> = (value: TValues, formApi: ExtendedFormApi<TValues>) => Record<string, any>;
+export type HandleSubmitFn<TValues extends Record<string, any> = Record<string, any>> = (values: TValues) => Promise<void> | void;
+export type HandleResetFn<TValues extends Record<string, any> = Record<string, any>> = (values: TValues) => Promise<void> | void;
 export type FieldMappingTime = [
     string,
     [
@@ -486,15 +493,15 @@ export interface TtFormProps<TValues extends Record<string, any> = Record<string
     /**
      * 表单重置回调
      */
-    handleReset?: HandleResetFn;
+    handleReset?: HandleResetFn<TValues>;
     /**
      * 表单提交回调
      */
-    handleSubmit?: HandleSubmitFn;
+    handleSubmit?: HandleSubmitFn<TValues>;
     /**
      * 表单值变化回调
      */
-    handleValuesChange?: (values: Record<string, any>, fieldsChanged: string[]) => void;
+    handleValuesChange?: (values: TValues, fieldsChanged: string[]) => void;
     /**
      * 重置按钮参数
      */
@@ -524,38 +531,63 @@ export interface TtFormProps<TValues extends Record<string, any> = Record<string
      */
     submitOnEnter?: boolean;
 }
-export type ExtendedFormApi = Omit<FormApi, "getValues" | "validate" | "setState"> & {
+/**
+ * 表单 api 对外类型。
+ *
+ * `FormApi` 类本身不带泛型（内部按 `Record<string, any>` 处理），泛型只在这一层对外收窄：
+ * 凡是吃/吐表单值与 schema 的方法都按 `TValues` 重新声明，其余方法沿用类的签名。
+ * 这样 `useForm<Data>()` 之后再调 `setState({ schema })` / `updateSchema` / `appendFields`，
+ * schema 里的 `dependencies` 回调依旧能推断出 `Data`。
+ *
+ * 这里保持 `Omit<类, ...>` 的写法（与改动前一致）：`Omit` 会抹掉类的私有成员，所以本类型
+ * 不能反向赋给 `FormApi`，但改动前就是这样，业务受影响面没变；换成与类交叉虽然能反向赋值，
+ * 代价是同名方法变成重载对、收窄签名匹配失败时静默退回类的宽松签名，
+ * `setValues({ age: "1" })` 这种字段类型写错就查不出来了。
+ * 分组表单那侧因为改动前直接暴露的是类本身，必须用交叉，见 `ExtendedGroupFormApi`。
+ */
+export type ExtendedFormApi<TValues extends Record<string, any> = Record<string, any>> = Omit<FormApi, "appendFields" | "getState" | "getValues" | "setValues" | "setState" | "updateSchema" | "validate"> & {
     /**
      * @description 设置表单状态，支持扩展字段（如 navAnchorProps、groupSchema 等）
-     * @param {Partial<TtFormProps & Record<string, any>> | ((prev: TtFormProps & Record<string, any>) => Partial<TtFormProps & Record<string, any>>)} stateOrFn - 新状态或更新函数
+     * @param stateOrFn - 新状态或更新函数
+     */
+    setState: (stateOrFn: ((prev: TtFormProps<TValues> & Record<string, any>) => Partial<TtFormProps<TValues> & Record<string, any>>) | Partial<TtFormProps<TValues> & Record<string, any>>) => void;
+    /**
+     * @description 读取当前表单状态
+     */
+    getState: () => null | TtFormProps<TValues>;
+    /**
+     * @description 写入表单值，已声明字段按 `TValues` 校验类型
+     */
+    setValues: (fields: FormValuesInput<TValues>, filterFields?: boolean, shouldValidate?: boolean) => Promise<void>;
+    /**
+     * @description 按 fieldName 局部更新 schema
      */
-    setState: (stateOrFn: ((prev: TtFormProps & Record<string, any>) => Partial<TtFormProps & Record<string, any>>) | Partial<TtFormProps & Record<string, any>>) => void;
+    updateSchema: (schema: Partial<FormSchema<TValues>>[]) => void;
     /**
      * 校验表单，支持通过第二个参数控制是否滚动到第一个错误分组
+     *
+     * 返回类型直接取 `FormApi.validate`，与运行时实际返回保持一致（`errors` 的值可能是 undefined）。
      * @param {any} [opts] - 原始 validate 选项
      * @param {boolean} [scrollToError] - 是否滚动到第一个错误分组，不传时使用全局配置 scrollToFirstError
      */
-    validate: (opts?: any, scrollToError?: boolean) => Promise<{
-        valid: boolean;
-        errors: Record<string, string>;
-        results?: any;
-    }>;
+    validate: (opts?: any, scrollToError?: boolean) => ReturnType<FormApi["validate"]>;
     /**
      * 获取表单值
      * @param {boolean} [isGroup] - 为 true 时返回按分组 key 嵌套的对象，默认 false 返回扁平值
      * @returns {Promise<T>} 表单值
      */
-    getValues: <T = Record<string, any>>(isGroup?: boolean) => Promise<T>;
-    useStore: <T = NoInfer<TtFormProps>>(selector?: (state: NoInfer<TtFormProps>) => T) => Readonly<Ref<T>>;
+    getValues: <T = TValues>(isGroup?: boolean) => Promise<T>;
+    useStore: <T = NoInfer<TtFormProps<TValues>>>(selector?: (state: NoInfer<TtFormProps<TValues>>) => T) => Readonly<Ref<T>>;
     /** 滚动到指定分组（仅 useGroupForm 场景下可用） */
     scrollToGroup?: (key: string) => void;
     /**
-     * 在指定分组中增量插入字段，无需全量重建 schema
-     * @param {string} groupKey - 目标分组的 key
-     * @param {any[]} fields - 要插入的字段或子结构（实际类型为 GroupFormSchema[]）
-     * @param {InsertPosition} [position] - 插入位置：before/after 匹配 fieldName、slot content 或 group key；省略则追加到末尾
+     * 增量插入字段，无需全量重建 schema。
+     *
+     * `useGroupForm` 下由 `GroupFormApi` 覆盖，接收的是分组 schema 树节点。
+     * @param fields - 要插入的字段或子结构
+     * @param position - 插入位置：before/after 匹配 fieldName、slot content 或 group key；省略则追加到末尾
      */
-    appendFields?: (groupKey: string, fields: any[], position?: {
+    appendFields: (fields: FormSchema<TValues>[], position?: {
         before?: string;
         after?: string;
     }) => void;

package/dist/components/tt-form/src/useForm.d.ts

@@ -1,2 +1,2 @@
 import { ExtendedFormApi, TtFormProps } from './types';
-export declare function useForm<TValues extends Record<string, any> = Record<string, any>>(options: TtFormProps<TValues>): readonly [import('vue').DefineSetupFnComponent<TtFormProps<TValues>, {}, {}, TtFormProps<TValues> & {}, import('vue').PublicProps>, ExtendedFormApi];
+export declare function useForm<TValues extends Record<string, any> = Record<string, any>>(options: TtFormProps<TValues>): readonly [import('vue').DefineSetupFnComponent<TtFormProps<TValues>, {}, {}, TtFormProps<TValues> & {}, import('vue').PublicProps>, ExtendedFormApi<TValues>];

package/dist/components/tt-form/src/useForm.js

@@ -4,12 +4,12 @@ import { FormApi as A } from "./formApi.js";
 import S from "./index.vue2.js";
 /* empty css          */
 function C(t) {
-  const n = a(t), e = new A(t), m = e;
-  m.useStore = (r) => p(e.store, r);
+  const n = a(t), e = new A(t), r = e;
+  r.useStore = (m) => p(e.store, m);
   const i = c(
-    (r, { attrs: o, slots: s }) => (f(() => {
+    (m, { attrs: o, slots: s }) => (f(() => {
       e.unmount();
-    }), e.setState({ ...r, ...o }), () => u(S, { ...r, ...o, formApi: m }, s)),
+    }), e.setState({ ...m, ...o }), () => u(S, { ...m, ...o, formApi: r }, s)),
     {
       name: "TtForm",
       inheritAttrs: !1
@@ -21,7 +21,7 @@ function C(t) {
       e.setState({ schema: t.schema });
     },
     { immediate: !0 }
-  ), [i, m];
+  ), [i, r];
 }
 export {
   C as useForm

package/dist/components/tt-modal-form/props.d.ts

@@ -1,9 +1,14 @@
-import { GroupFormApi, TtExtendedFormApi, TtFormProps, UseGroupFormOptions } from '../tt-form';
+import { ExtendedGroupFormApi, TtExtendedFormApi, TtFormProps, UseGroupFormOptions } from '../tt-form';
 import { ModalApiOptions, TtModalExtendedModalApi } from '../tt-modal';
 /** modal-form 使用的表单类型。 */
 export type ModalFormType = "form" | "groupForm";
-/** modal-form 对外暴露的表单 API 类型。 */
-export type ModalFormApi<TType extends ModalFormType = "form"> = TType extends "groupForm" ? GroupFormApi : TtExtendedFormApi;
+/**
+ * modal-form 对外暴露的表单 API 类型。
+ *
+ * `TValues` 跟着 `formProps` 走，`getFormApi` 拿到的 api 上 `getValues` / `setState({ schema })`
+ * 等方法也按业务的值类型收窄。
+ */
+export type ModalFormApi<TType extends ModalFormType = "form", TValues extends Record<string, any> = Record<string, any>> = TType extends "groupForm" ? ExtendedGroupFormApi<TValues> : TtExtendedFormApi<TValues>;
 /** 根据表单类型收窄的表单配置。 */
 type ModalFormProps<TValues extends Record<string, any>, TType extends ModalFormType> = TType extends "groupForm" ? Partial<UseGroupFormOptions<TValues>> : Partial<TtFormProps<TValues>>;
 export type TtModalFormProps<TType extends ModalFormType = "form", TValues extends Record<string, any> = Record<string, any>> = {
@@ -40,7 +45,7 @@ export type TtModalFormProps<TType extends ModalFormType = "form", TValues exten
     /** modal props */
     modalProps?: ModalApiOptions;
     /** 获取formApi的回调 */
-    getFormApi?: (api: ModalFormApi<TType>) => void;
+    getFormApi?: (api: ModalFormApi<TType, TValues>) => void;
     /** 获取modalApi的回调 */
     getModalApi?: (api: TtModalExtendedModalApi) => void;
     /** 处理TtSelect(非多选回显值) */

package/dist/components/tt-modal-form/useModalForm.d.ts

@@ -2,6 +2,6 @@ import { TtModalExtendedModalApi } from '../tt-modal';
 import { ModalFormApi, ModalFormType, TtModalFormProps } from './props';
 /** 创建普通表单或分组表单的弹窗表单。 */
 export declare function useModalForm<TType extends ModalFormType = "form", TValues extends Record<string, any> = Record<string, any>>(options: TtModalFormProps<TType, TValues>): readonly [import('vue').DefineSetupFnComponent<Partial<TtModalFormProps<ModalFormType>>, {}, {}, Partial<TtModalFormProps<ModalFormType>> & {}, import('vue').PublicProps>, {
-    readonly formApi: import('vue').Ref<ModalFormApi<TType> | undefined, ModalFormApi<TType> | undefined>;
+    readonly formApi: import('vue').Ref<ModalFormApi<TType, TValues> | undefined, ModalFormApi<TType, TValues> | undefined>;
     readonly modalApi: import('vue').Ref<TtModalExtendedModalApi | undefined, TtModalExtendedModalApi | undefined>;
 }];

package/dist/components/tt-table/index.d.ts

@@ -207,6 +207,10 @@ export declare const TtTable: import('../../../../utils/src').SFCWithInstall<{
             type: import('vue').PropType<import('.').TtTableProps["beforeFetch"]>;
             default: null;
         };
+        beforePageChange: {
+            type: import('vue').PropType<import('.').TtTableProps["beforePageChange"]>;
+            default: null;
+        };
         data: {
             type: import('vue').PropType<import('.').TtTableProps["data"]>;
             default: () => import('.').TtTableProps["data"];
@@ -523,6 +527,7 @@ export declare const TtTable: import('../../../../utils/src').SFCWithInstall<{
         api: (...arg: any[]) => Promise<any>;
         afterFetch: ((data: any[], res: Recordable | Recordable[]) => Promise<any[]>) | undefined;
         beforeFetch: ((params: Recordable) => Promise<Recordable>) | undefined;
+        beforePageChange: ((page: import("vxe-table").VxeGridPropTypes.PagerConfig) => boolean | Promise<boolean>) | undefined;
     }, true, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {
         wrapRef: HTMLDivElement;
         xGrid: (import('vxe-table').VxeGridMethods<any> & {
@@ -894,6 +899,10 @@ export declare const TtTable: import('../../../../utils/src').SFCWithInstall<{
             type: import('vue').PropType<import('.').TtTableProps["beforeFetch"]>;
             default: null;
         };
+        beforePageChange: {
+            type: import('vue').PropType<import('.').TtTableProps["beforePageChange"]>;
+            default: null;
+        };
         data: {
             type: import('vue').PropType<import('.').TtTableProps["data"]>;
             default: () => import('.').TtTableProps["data"];
@@ -1208,6 +1217,7 @@ export declare const TtTable: import('../../../../utils/src').SFCWithInstall<{
         api: (...arg: any[]) => Promise<any>;
         afterFetch: ((data: any[], res: Recordable | Recordable[]) => Promise<any[]>) | undefined;
         beforeFetch: ((params: Recordable) => Promise<Recordable>) | undefined;
+        beforePageChange: ((page: import("vxe-table").VxeGridPropTypes.PagerConfig) => boolean | Promise<boolean>) | undefined;
     }>;
     __isFragment?: never;
     __isTeleport?: never;
@@ -1312,6 +1322,10 @@ export declare const TtTable: import('../../../../utils/src').SFCWithInstall<{
         type: import('vue').PropType<import('.').TtTableProps["beforeFetch"]>;
         default: null;
     };
+    beforePageChange: {
+        type: import('vue').PropType<import('.').TtTableProps["beforePageChange"]>;
+        default: null;
+    };
     data: {
         type: import('vue').PropType<import('.').TtTableProps["data"]>;
         default: () => import('.').TtTableProps["data"];
@@ -1628,6 +1642,7 @@ export declare const TtTable: import('../../../../utils/src').SFCWithInstall<{
     api: (...arg: any[]) => Promise<any>;
     afterFetch: ((data: any[], res: Recordable | Recordable[]) => Promise<any[]>) | undefined;
     beforeFetch: ((params: Recordable) => Promise<Recordable>) | undefined;
+    beforePageChange: ((page: import("vxe-table").VxeGridPropTypes.PagerConfig) => boolean | Promise<boolean>) | undefined;
 }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
     $slots: Readonly<{
         [key: string]: (props: import('../../../../utils/src').Recordable) => void;

package/dist/components/tt-table/src/Table.vue.d.ts

@@ -393,6 +393,10 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
         type: import('vue').PropType<TtTableProps["beforeFetch"]>;
         default: null;
     };
+    beforePageChange: {
+        type: import('vue').PropType<TtTableProps["beforePageChange"]>;
+        default: null;
+    };
     data: {
         type: import('vue').PropType<TtTableProps["data"]>;
         default: () => TtTableProps["data"];
@@ -744,6 +748,10 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
         type: import('vue').PropType<TtTableProps["beforeFetch"]>;
         default: null;
     };
+    beforePageChange: {
+        type: import('vue').PropType<TtTableProps["beforePageChange"]>;
+        default: null;
+    };
     data: {
         type: import('vue').PropType<TtTableProps["data"]>;
         default: () => TtTableProps["data"];
@@ -967,6 +975,7 @@ declare const __VLS_component: import('vue').DefineComponent<import('vue').Extra
     api: (...arg: any[]) => Promise<any>;
     afterFetch: ((data: any[], res: globalThis.Recordable | globalThis.Recordable[]) => Promise<any[]>) | undefined;
     beforeFetch: ((params: globalThis.Recordable) => Promise<globalThis.Recordable>) | undefined;
+    beforePageChange: ((page: import("vxe-table").VxeGridPropTypes.PagerConfig) => boolean | Promise<boolean>) | undefined;
 }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {
     wrapRef: HTMLDivElement;
     xGrid: (import('vxe-table').VxeGridMethods<any> & {