@zat-design/sisyphus-react 3.11.14-beta.1 → 3.11.14-beta.10

package/es/ProForm/components/combination/FormList/propsType.d.ts

@@ -3,7 +3,7 @@ import type { FormInstance } from 'antd/es/form/Form';
 import type { ButtonProps, FormListFieldData, FormListOperation, PopconfirmProps } from 'antd';
 import type { InternalNamePath } from 'antd/es/form/interface';
 import type { levelType } from '../../../../ProLayout/components/ProCollapse/PropTypes';
-import type { ProColumnProps, ProFormOtherProps } from '../../../propsType';
+import type { ProColumnType, ProFormOtherType } from '../../../propsType';
 export type TitleRender = (record: Record<string, any>, index: number, form: FormInstance) => any;
 export type TitleType = string | React.ReactNode | TitleRender;
 type Callback = (record: any, option: Pick<Option, 'namePath' | 'index' | 'operation' | 'form'>) => any | void;
@@ -14,7 +14,7 @@ export interface Option {
     form: FormInstance;
     operation: FormListOperation;
 }
-export interface ActionProps extends Omit<ButtonProps, 'onClick' | 'type'> {
+export interface ActionType extends Omit<ButtonProps, 'onClick' | 'type'> {
     type?: 'add' | 'delete' | 'copy' | 'moveUp' | 'moveDown';
     onHandle?: Callback;
     onClick?: Callback;
@@ -24,21 +24,21 @@ export interface ActionProps extends Omit<ButtonProps, 'onClick' | 'type'> {
     title?: string;
     show?: boolean | ((record: any, option: Pick<Option, 'index' | 'form' | 'namePath'>) => boolean);
 }
-export interface ToolbarActionProps extends Omit<ActionProps, 'actionType' | 'onHandle' | 'onClick' | 'show' | 'type'> {
+export interface ToolbarActionType extends Omit<ActionType, 'actionType' | 'onHandle' | 'onClick' | 'show' | 'type'> {
     type?: 'add';
     onHandle?: ToolbarCallback;
     onClick?: ToolbarCallback;
     show?: boolean | ((record: any, option: Pick<Option, 'form' | 'namePath'>) => boolean);
 }
 export type FormListMode = 'block' | 'line' | 'less';
-export interface FormListProps {
-    columns: ProColumnProps[];
-    otherProps?: ProFormOtherProps;
+export interface FormListType {
+    columns: ProColumnType[];
+    otherProps?: ProFormOtherType;
     form?: FormInstance;
     min?: number;
     max?: number;
-    actionProps?: ActionProps[] | false;
-    toolbarProps?: ToolbarActionProps[] | false;
+    actionProps?: ActionType[] | false;
+    toolbarProps?: ToolbarActionType[] | false;
     value?: any[];
     onChange?: (record: any[], option: Pick<Option, 'namePath' | 'form'>) => void;
     fields: FormListFieldData[];
@@ -56,8 +56,16 @@ export interface FormListProps {
     draggable?: boolean;
     id?: string;
 }
-export type PropsWithRef = FormListProps & React.RefAttributes<FormListRef>;
-export interface FormListRef {
+export type TypeWithRef = FormListType & React.RefAttributes<FormListRefType>;
+export interface FormListRefType {
     operation: FormListOperation;
 }
+/**
+ * 兼容旧命名导出
+ */
+export type ActionProps = ActionType;
+export type ToolbarActionProps = ToolbarActionType;
+export type FormListProps = FormListType;
+export type PropsWithRef = TypeWithRef;
+export type FormListRef = FormListRefType;
 export {};

package/es/ProForm/components/combination/Group/index.d.ts

@@ -1,10 +1,10 @@
 import React from 'react';
-import { GroupProps } from './propsType';
+import { GroupType } from './propsType';
 /**
  * 1. 外层过滤FormItem相关属性, 但是子元素上的 required [disabled] [show] rules [fieldProps] [component] 需要取到并
  * 2.
  *
  * render内部能力 show, component, value, onChange, disabled, clearNotShow, fieldProps
  */
-declare const Group: React.FC<GroupProps>;
+declare const Group: React.FC<GroupType>;
 export default Group;

package/es/ProForm/components/combination/Group/propsType.d.ts

@@ -2,7 +2,7 @@ import React from 'react';
 import { FormItemProps, ModalFuncProps, SpaceProps } from 'antd';
 import { FormInstance } from 'antd/es/form/Form';
 import { NamePath } from 'antd/lib/form/interface';
-import { ColumnPropsMap, FunctionArgs, ProFormValueType, ReactiveFunction, ViewType } from '../../../propsType';
+import { ColumnTypeMap, FunctionArgs, ProFormValueType, ReactiveFunction, ViewType } from '../../../propsType';
 export interface SpaceType extends SpaceProps {
     /**
      * 是否紧凑合并
@@ -17,8 +17,8 @@ export interface SpaceType extends SpaceProps {
     /** 间隔距离 */
     size?: number;
 }
-export interface GroupProps {
-    children?: GroupColumnProps[];
+export interface GroupType {
+    children?: GroupColumnType[];
     space?: SpaceType;
     className?: string;
     id?: string;
@@ -28,7 +28,7 @@ export interface GroupProps {
     onChange?: (value: any[] | null, options?: any[]) => void;
     otherProps?: any;
 }
-export type GroupColumnProps<Values = any> = {
+export type GroupColumnType<Values = any> = {
     component?: React.ReactNode | ReactiveFunction<Values, React.ReactNode>;
     names?: NamePath[];
     show?: boolean | ReactiveFunction<Values, boolean>;
@@ -51,4 +51,9 @@ export type GroupColumnProps<Values = any> = {
     valuePropName?: string;
     getValueProps?: (value: any) => Record<string, unknown>;
     desensitization?: [number, number] | ReactiveFunction<Values, [number, number]>;
-} & ColumnPropsMap & FormItemProps;
+} & ColumnTypeMap & FormItemProps;
+/**
+ * 兼容旧命名导出
+ */
+export type GroupProps = GroupType;
+export type GroupColumnProps<Values = any> = GroupColumnType<Values>;

package/es/ProForm/components/combination/Group/utils.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { InternalNamePath, NamePath } from 'antd/lib/form/interface';
 import { FormInstance } from 'antd';
-import { GroupColumnProps, GroupProps, SpaceType } from './propsType';
+import { GroupColumnType, GroupType, SpaceType } from './propsType';
 import { ProFormColumnProps, ReactiveFunction } from '../../render/propsType';
 export type EventArgs = any[];
 /**
@@ -9,7 +9,7 @@ export type EventArgs = any[];
  * @param columns 表单配置数组
  * @returns
  */
-export declare const insertSeparator: (columns: GroupColumnProps[], space?: SpaceType) => any[];
+export declare const insertSeparator: (columns: GroupColumnType[], space?: SpaceType) => any[];
 /** 带出event的组件默认取值方法 */
 export declare function defaultGetValueFromEvent(valuePropName: string, ...args: EventArgs): any;
 /** 转换names */
@@ -51,7 +51,7 @@ export declare const getValueTypeTrans: (params: ValueTypeGetterParams) => any;
 /** 执行所有中间件 返回处理后的值 */
 export declare const getValueMiddleware: (value: any, callbacks?: any[]) => any;
 interface ColumnsTransformerParams {
-    columns: GroupColumnProps[];
+    columns: GroupColumnType[];
     name?: NamePath;
     names?: NamePath[];
     value?: any[];
@@ -61,7 +61,7 @@ interface ColumnsTransformerParams {
     index?: number;
     formDisabled?: boolean;
     desensitizationKey?: string;
-    groupProps: GroupProps;
+    groupProps: GroupType;
 }
 /** 转换columns */
 export declare const useTransformColumns: (params: ColumnsTransformerParams) => any[];

package/es/ProForm/components/combination/ProCascader/index.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
-import { ProCascaderProps } from './propsType';
-declare const _default: import("react").MemoExoticComponent<(props: ProCascaderProps) => import("react/jsx-runtime").JSX.Element>;
+import { ProCascaderType } from './propsType';
+declare const _default: import("react").MemoExoticComponent<(props: ProCascaderType) => import("react/jsx-runtime").JSX.Element>;
 export default _default;

package/es/ProForm/components/combination/ProCascader/propsType.d.ts

@@ -1,13 +1,13 @@
 import { ReactNode } from 'react';
 import { DefaultOptionType } from 'rc-select/lib/Select';
 import { Service } from 'ahooks/lib/useRequest/src/types';
-export interface fieldNamesProps {
+export interface FieldNamesType {
     label: string;
     value: string;
     children?: string;
     [key: string]: string;
 }
-export interface ProCascaderProps {
+export interface ProCascaderType {
     className?: string;
     mode?: 'address' | 'default';
     isView?: boolean;
@@ -16,7 +16,7 @@ export interface ProCascaderProps {
     hasDetail?: boolean;
     tooltip?: boolean | ReactNode;
     detailMaxLength?: number;
-    fieldNames?: fieldNamesProps;
+    fieldNames?: FieldNamesType;
     dataSource?: DefaultOptionType[];
     useRequest?: {
         loadData?: boolean;
@@ -38,3 +38,8 @@ export interface ProCascaderProps {
     scrollFollowParent?: boolean;
     desensitization?: [number, number];
 }
+/**
+ * 兼容旧命名导出
+ */
+export type fieldNamesProps = FieldNamesType;
+export type ProCascaderProps = ProCascaderType;

package/es/ProForm/components/combination/ProCombination/index.d.ts

@@ -1,6 +1,6 @@
 import { FC } from 'react';
-import { ProCombinationProps, ChildPropsItemProps } from './propsType';
+import { ProCombinationType, ChildPropsItemType } from './propsType';
 import './style/index.less';
-export declare const ProCombination: FC<ProCombinationProps>;
-export declare const childPropsItemProps: FC<ChildPropsItemProps>;
+export declare const ProCombination: FC<ProCombinationType>;
+export declare const childPropsItemProps: FC<ChildPropsItemType>;
 export default ProCombination;

package/es/ProForm/components/combination/ProCombination/propsType.d.ts

@@ -2,8 +2,8 @@ import { FieldNames } from 'rc-select/lib/Select';
 import { FormInstance } from 'antd';
 import React from 'react';
 import * as componentMap from '../../index';
-import { ProFormOtherProps } from '../../../propsType';
-export interface ChildPropsItemProps {
+import { ProFormOtherType } from '../../../propsType';
+export interface ChildPropsItemType {
     /**
      * @description       要显示什么组件，支持Input/Select
      * @default           Input
@@ -22,7 +22,7 @@ export interface ChildPropsItemProps {
     onChange?: (value: any, option: any, form: FormInstance) => void;
     [name: string]: any;
 }
-export interface ProCombinationProps {
+export interface ProCombinationType {
     /**
      * @description       组件的值,[第一个组件的值,第二个组件的值,]
      * @default           []
@@ -42,7 +42,7 @@ export interface ProCombinationProps {
      * @description       子组件内部组件可配置属性,按照数组顺序注入到内部组件中
      * @default           [{},{}]
      */
-    childProps?: Array<ChildPropsItemProps>;
+    childProps?: Array<ChildPropsItemType>;
     /**
      * @description       是否视图模式
      * @default           false
@@ -58,6 +58,11 @@ export interface ProCombinationProps {
      * @default           '-'
      */
     separator?: string;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     id?: string;
 }
+/**
+ * 兼容旧命名导出
+ */
+export type ChildPropsItemProps = ChildPropsItemType;
+export type ProCombinationProps = ProCombinationType;

package/es/ProForm/components/combination/ProModalSelect/index.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
-import { ProModalSelectPropsType } from './propsType';
-declare const _default: React.ForwardRefExoticComponent<Omit<ProModalSelectPropsType, "ref"> & React.RefAttributes<unknown>>;
+import { ProModalSelectType } from './propsType';
+declare const _default: React.ForwardRefExoticComponent<Omit<ProModalSelectType, "ref"> & React.RefAttributes<unknown>>;
 export default _default;

package/es/ProForm/components/combination/ProModalSelect/propsType.d.ts

@@ -1,49 +1,102 @@
 import { FormInstance, InputProps, SelectProps, ModalProps } from 'antd';
 import { Service, Options } from 'ahooks/lib/useRequest/src/types';
 import React from 'react';
-import { ProColumnProps } from '../../render/propsType';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProColumnType } from '../../render/propsType';
+import { ProFormOtherType } from '../../../propsType';
+/**
+ * 模态框确认按钮回调函数类型
+ * @param list 选中的数据列表
+ * @returns 返回布尔值或Promise<布尔值>，用于控制模态框是否关闭
+ */
 type OnOkFunction = (list?: Record<string, any>[]) => boolean | void | Promise<boolean | void>;
+/**
+ * 配置选项接口
+ */
 interface ConfigOption {
+    /** ahooks的useRequest参数配置 */
     useRequest?: {
+        /** 请求服务 */
         service?: Service<any, any>;
+        /** useRequest选项配置 */
         options?: Options<any, any> & {
             page?: any;
             defaultParams?: any;
             initParams?: any;
         };
+        /** 初始化参数 */
         initParams?: any;
     };
-    formColumns?: ProColumnProps[];
+    /** 表单列配置项 */
+    formColumns?: ProColumnType[];
+    /** 选择模式：单选(radio)或多选(checkbox) */
     type?: 'radio' | 'checkbox';
+    /** 是否开启分页功能 */
     withPagination?: boolean;
+    /** 转换请求参数 */
     transformParams?: (params: any) => any;
+    /** 转换响应数据 */
     transformResponse?: (data: any[]) => any[];
+    /** 模态框属性配置 */
     modalProps?: ModalProps & {
         onOk?: OnOkFunction;
     };
+    /** 表格属性配置 */
     tableProps?: Record<string, any>;
 }
+/**
+ * 模态框选择器属性接口
+ */
 interface ProModalPropsType {
+    /** 配置选项 */
     configOption: ConfigOption;
+    /** 值变更回调 */
     onChange?: (value: number | string | undefined, option?: any) => void;
+    /** 弹框标题 */
     title: ModalProps['title'];
+    /** 组件引用 */
     ref?: React.MutableRefObject<any>;
+    /** 自定义格式化显示值 */
     onFormat?: (value: any) => string;
+    /** 自定义选项渲染函数 */
     optionRender?: (value: any) => string;
+    /** 自定义字段名映射 */
     fieldNames?: any;
+    /** 是否为查看模式 */
     isView?: boolean;
+    /** 自定义组件渲染 */
     customRender?: React.ReactNode;
+    /** 自定义空数据展示组件 */
     viewEmpty?: React.ReactNode;
-    otherProps?: ProFormOtherProps;
+    /** ProForm中传递的其他参数 */
+    otherProps?: ProFormOtherType;
+    /**
+     * 是否将选项的label包装到value中
+     * 会将Select的value类型从string变为{value: string, label: ReactNode}格式
+     */
     labelInValue?: boolean;
+    /** 是否默认选择列表第一项 */
     defaultOne?: boolean;
+    /** 打开弹框前的校验函数 */
     beforeOpen?: any;
+    /** 打开弹框后的回调函数 */
     afterOpen?: any;
-    isTooltip?: any;
+    /** 是否启用tooltip提示 */
+    isTooltip?: boolean;
+    /** 是否以"值-名称"形式展示 */
     showCodeName?: boolean;
+    /** 查询表单实例，用于获取查询表单数据 */
     searchForm?: FormInstance;
+    /** 模糊查询的字段名 */
     searchKey?: string;
 }
+/** 模态框选择器属性类型（结合Select和Input属性） */
 export declare type ProModalSelectPropsType = SelectProps & InputProps & ProModalPropsType;
+/** 配置选项类型 */
+export type ConfigOptionType = ConfigOption;
+/** 模态框属性类型 */
+export type ProModalType = Omit<ProModalPropsType, 'configOption'> & {
+    configOption: ConfigOptionType;
+};
+/** 模态框选择器类型（结合Select和Input属性） */
+export type ProModalSelectType = SelectProps & InputProps & ProModalType;
 export {};

package/es/ProForm/components/combination/ProNumberRange/propsType.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
-export interface ProNumberRangeProps {
+import { ProFormOtherType } from '../../../propsType';
+export interface ProNumberRangeType {
     /**
      * @description       组件的值,[最小值，最大值]
      * @default           []
@@ -75,6 +75,10 @@ export interface ProNumberRangeProps {
      */
     separator?: React.ReactNode | string;
     childProps?: any[];
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     id?: string;
 }
+/**
+ * 兼容旧命名导出
+ */
+export type ProNumberRangeProps = ProNumberRangeType;

package/es/ProForm/components/combination/ProTimeLimit/index.d.ts

@@ -2,20 +2,20 @@ import { DatePickerProps, TimePickerProps } from 'antd';
 import { PickerPanelDateProps } from 'antd/lib/calendar/generateCalendar';
 import { Moment } from 'moment';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
-import { Props as ProRangeLimitProps } from '../ProRangeLimit';
+import { ProFormOtherType } from '../../../propsType';
+import { Props as ProRangeLimitType } from '../ProRangeLimit';
 import { DistributiveOmit } from '../../../../ProForm/propsType';
 export type DateType = DatePickerProps['value'];
-export type ProTimeLimitProps = DistributiveOmit<DatePickerProps, 'value' | 'onChange' | 'mode'> & {
+export type ProTimeLimitType = DistributiveOmit<DatePickerProps, 'value' | 'onChange' | 'mode'> & {
     value?: string;
-    onChange?: (value: ProTimeLimitProps['value'] | null, valueData: Moment) => void;
+    onChange?: (value: ProTimeLimitType['value'] | null, valueData: Moment) => void;
     disabled?: boolean;
     foreverDate?: string;
     foreverText?: string;
     viewEmpty?: React.ReactNode;
     format?: string;
     valueType?: 'moment' | 'format' | 'ISO' | 'dateTime' | 'dateStartEndTime';
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     mode?: 'DatePicker';
     isView?: boolean;
     /**
@@ -26,9 +26,15 @@ export type ProTimeLimitProps = DistributiveOmit<DatePickerProps, 'value' | 'onC
     showTime?: PickerPanelDateProps<Moment>['showTime'];
     showNow?: boolean;
 };
-export declare const ProTimeLimit: React.FC<ProTimeLimitProps>;
-export type ProLimitProps = ProTimeLimitProps | (ProRangeLimitProps & {
+export declare const ProTimeLimit: React.FC<ProTimeLimitType>;
+export type ProLimitType = ProTimeLimitType | (ProRangeLimitType & {
     mode: 'RangePicker';
 });
-declare const LimitPick: React.FC<ProLimitProps>;
+declare const LimitPick: React.FC<ProLimitType>;
 export default LimitPick;
+/**
+ * 兼容旧命名导出
+ */
+export type ProTimeLimitProps = ProTimeLimitType;
+export type ProLimitProps = ProLimitType;
+export type Props = ProRangeLimitType;

package/es/ProForm/components/render/ChangedWrapper.d.ts

@@ -2,12 +2,12 @@ import { FormInstance } from 'antd';
 import { NamePath } from 'antd/lib/form/interface';
 import React from 'react';
 import { DiffOriginalParams } from '../../utils/diffOriginal';
-import { DiffConfigProps } from '../../propsType';
+import { DiffConfigType } from '../../propsType';
 interface Props {
     name?: NamePath;
     names?: NamePath[];
     namesStr?: string;
-    diffConfig?: DiffConfigProps;
+    diffConfig?: DiffConfigType;
     form: FormInstance;
     onDiff?: DiffOriginalParams['onDiff'];
     valuePropName?: string;

package/es/ProForm/components/render/Render.d.ts

@@ -1,4 +1,4 @@
 import React from 'react';
-import type { RenderProps } from './propsType';
-declare const Render: React.FC<RenderProps>;
+import type { RenderType } from './propsType';
+declare const Render: React.FC<RenderType>;
 export default Render;

package/es/ProForm/components/render/RenderFields.d.ts

@@ -1,11 +1,11 @@
 import { ColProps } from 'antd';
 import { FormInstance } from 'antd/es/form/Form';
 import React from 'react';
-import { ProColumnProps } from './propsType';
-import { DiffConfigProps } from '../../propsType';
+import { ProColumnType } from './propsType';
+import { DiffConfigType } from '../../propsType';
 interface Props<T = any> {
     isView?: boolean;
-    columns: ProColumnProps[];
+    columns: ProColumnType[];
     disabled?: boolean;
     form: FormInstance<T>;
     expand?: boolean | number;
@@ -15,7 +15,7 @@ interface Props<T = any> {
     viewEmpty?: React.ReactNode;
     openState?: boolean;
     labelWidth?: string | number;
-    diffConfig?: DiffConfigProps;
+    diffConfig?: DiffConfigType;
     clearNotShow?: boolean;
     requiredOnView?: boolean;
     required?: boolean | boolean[] | (() => boolean | boolean[]);