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

package/es/ProEnum/propsType.d.ts

@@ -1,95 +1,284 @@
 import React, { ReactNode } from 'react';
 import { RadioProps, CheckboxProps } from 'antd';
 import { Service, Options } from 'ahooks/lib/useRequest/src/types';
-import { ProFormOtherProps } from '../index';
+import { ProFormOtherType } from '../index';
 import { PropSelectProps } from '../ProSelect/propsType';
-export interface DataOption {
+/**
+ * @description 数据选项类型
+ */
+export interface DataOptionType {
+    /**
+     * @description 展示标签
+     * @default -
+     */
     label?: string;
+    /**
+     * @description 选项值
+     * @default -
+     */
     value?: string;
+    /**
+     * @description 是否禁用
+     * @default false
+     */
     disabled?: boolean;
+    /**
+     * @description 允许扩展字段
+     */
     [key: string]: any;
 }
-export interface ProEnumConfig {
-    /** 是否枚举主入口 */
+/**
+ * @description ProEnum配置类型
+ */
+export interface ProEnumConfigType {
+    /**
+     * @description 是否枚举主入口
+     * @default false
+     */
     main?: boolean;
-    /** 是否使用主入口枚举 */
+    /**
+     * @description 是否使用主入口枚举
+     * @default false
+     */
     share?: boolean;
-    /** 是否开启调试 log */
+    /**
+     * @description 是否开启调试 log
+     * @default false
+     */
     debugger?: boolean;
-    /** 是否对数据进行清洗 */
+    /**
+     * @description 是否对数据进行清洗
+     * @default false
+     */
     clear?: boolean;
-    /** 字段别名 */
+    /**
+     * @description 字段别名
+     * @default { label: 'label', value: 'value', children: 'children' }
+     */
     fieldNames?: Record<'label' | 'value' | 'children', string>;
-    /** 缓存的key、默认 zat-design-pro-component-cacheKey */
+    /**
+     * @description 缓存的key、默认 zat-design-pro-component-cacheKey
+     * @default "zat-design-pro-component-cacheKey"
+     */
     cacheKey: string;
-    /** 刷新请求、设置后每次进入都会重新请求 */
+    /**
+     * @description 刷新请求、设置后每次进入都会重新请求
+     * @default false
+     */
     requestRefresh: boolean;
-    /** 存储位置、不设置、默认读取 globalConfig 里面的 */
+    /**
+     * @description 存储位置、不设置、默认读取 globalConfig 里面的
+     * @default "localStorage"
+     */
     storage: 'localStorage' | 'sessionStorage';
-    /** 默认静态枚举数据 */
-    dataSource: Record<string, DataOption[]>;
-    /** 对后台返回数据进行格式化 */
+    /**
+     * @description 默认静态枚举数据
+     * @default {}
+     */
+    dataSource: Record<string, DataOptionType[]>;
+    /**
+     * @description 对后台返回数据进行格式化
+     * @param data 后台返回的数据
+     * @returns 格式化后的枚举数据
+     * @default -
+     */
     transformResponse?: (data: {
-        data: Record<string, DataOption[]>;
-    }) => Record<string, DataOption[]> | Promise<Record<string, DataOption[]>>;
-    /** 批量请求枚举接口 */
+        data: Record<string, DataOptionType[]>;
+    }) => Record<string, DataOptionType[]> | Promise<Record<string, DataOptionType[]>>;
+    /**
+     * @description 批量请求枚举接口
+     * @default -
+     */
     useRequest?: {
+        /**
+         * @description 请求服务函数
+         */
         service: Service<any, any>;
+        /**
+         * @description 请求选项配置
+         */
         options?: Options<any, any> & {
+            /**
+             * @description 指定请求的枚举码
+             */
             codes?: string[];
+            /**
+             * @description 忽略的枚举码
+             */
             ignoreCodes?: string[];
         };
     };
-    dics: Record<string, DataOption[]>;
+    /**
+     * @description 字典数据
+     * @default {}
+     */
+    dics: Record<string, DataOptionType[]>;
 }
-type ProEnumType = 'ProSelect' | 'Radio' | 'Checkbox' | 'Tag' | 'Group';
-export interface ProEnum {
-    /** 组件展示类型、默认 ProSelect */
-    type?: ProEnumType;
-    /** 用于自定义组件 */
+/**
+ * @description 枚举组件类型枚举
+ */
+type EnumComponentType = 'ProSelect' | 'Radio' | 'Checkbox' | 'Tag' | 'Group';
+/**
+ * @description ProEnum基础属性类型
+ */
+export interface ProEnumBaseType {
+    /**
+     * @description 组件展示类型、默认 ProSelect
+     * @default "ProSelect"
+     */
+    type?: EnumComponentType;
+    /**
+     * @description 用于自定义组件
+     * @default -
+     */
     component?: ReactNode;
-    /** 用于提交 code */
+    /**
+     * @description 用于提交 code
+     * @default -
+     */
     code?: string | string[];
-    /** 字段别名 */
+    /**
+     * @description 字段别名
+     * @default -
+     */
     fieldNames?: Record<string, string>;
-    /** 是否查看模式 */
+    /**
+     * @description 是否查看模式
+     * @default false
+     */
     isView?: boolean;
-    /** 数据源 */
-    dataSource?: DataOption[];
+    /**
+     * @description 数据源
+     * @default -
+     */
+    dataSource?: DataOptionType[];
+    /**
+     * @description 当前值
+     * @default -
+     */
     value: any;
+    /**
+     * @description 值变化回调
+     * @default -
+     */
     onChange?: (value: any) => void;
-    /** 远程请求接口 */
+    /**
+     * @description 远程请求接口
+     * @default -
+     */
     useRequest?: {
+        /**
+         * @description 请求服务函数
+         */
         service: Service<any, any>;
+        /**
+         * @description 请求选项
+         */
         options?: Options<any, any>;
     };
-    /** 对后台返回数据进行格式化 */
-    transformResponse?: (data: any) => DataOption[];
-    /** 时候合并 */
+    /**
+     * @description 对后台返回数据进行格式化
+     * @param data 后台返回的数据
+     * @returns 格式化后的选项数据
+     * @default -
+     */
+    transformResponse?: (data: any) => DataOptionType[];
+    /**
+     * @description 是否合并数据
+     * @default false
+     */
     merge?: boolean;
-    /** 查看模式下为空展示 */
+    /**
+     * @description 查看模式下为空展示
+     * @default "-"
+     */
     viewEmpty?: React.ReactNode;
+    /**
+     * @description 自定义选项渲染
+     * @default -
+     */
     optionRender?: any;
-    /** 显示 code-value 形式 */
+    /**
+     * @description 显示 code-value 形式
+     * @default false
+     */
     showCodeName?: boolean;
-    /** 支持 {label:xx, value: xx} */
+    /**
+     * @description 支持 {label:xx, value: xx} 形式
+     * @default false
+     */
     labelInValue?: boolean;
-    otherProps?: ProFormOtherProps;
+    /**
+     * @description 其他表单属性
+     * @default -
+     */
+    otherProps?: ProFormOtherType;
+    /**
+     * @description 是否允许清除
+     * @default false
+     */
     allowClear?: boolean;
+    /**
+     * @description 组件ID
+     * @default -
+     */
     id?: string;
+    /**
+     * @description 默认值
+     * @default -
+     */
     defaultValue?: any;
 }
-export type PropProSelectsMap = {
+/**
+ * @description ProSelect类型映射
+ */
+export type PropProSelectsMapType = {
+    /**
+     * @description 类型为ProSelect
+     * @default "ProSelect"
+     */
     type?: 'ProSelect';
 } & PropSelectProps;
-export type PropRadioPropsMap = {
+/**
+ * @description Radio类型映射
+ */
+export type PropRadioPropsMapType = {
+    /**
+     * @description 类型为Radio
+     * @default "Radio"
+     */
     type?: 'Radio';
 } & RadioProps;
-export type CheckboxPropsMap = {
+/**
+ * @description Checkbox类型映射
+ */
+export type CheckboxPropsMapType = {
+    /**
+     * @description 类型为Checkbox
+     * @default "Checkbox"
+     */
     type?: 'Checkbox';
 } & CheckboxProps;
-export interface TagPropsMap {
+/**
+ * @description Tag类型映射
+ */
+export interface TagPropsMapType {
+    /**
+     * @description 类型为Tag或Group
+     * @default -
+     */
     type?: 'Tag' | 'Group';
 }
-export type ProEnumProps = Omit<ProEnum, 'type'> & (PropProSelectsMap | PropRadioPropsMap | CheckboxPropsMap | TagPropsMap);
+/**
+ * @description ProEnum组件属性类型
+ */
+export type ProEnumType = Omit<ProEnumBaseType, 'type'> & (PropProSelectsMapType | PropRadioPropsMapType | CheckboxPropsMapType | TagPropsMapType);
+export type DataOption = DataOptionType;
+export type ProEnumConfig = ProEnumConfigType;
+export type ProEnum = ProEnumBaseType;
+export type PropProSelectsMap = PropProSelectsMapType;
+export type PropRadioPropsMap = PropRadioPropsMapType;
+export type CheckboxPropsMap = CheckboxPropsMapType;
+export type TagPropsMap = TagPropsMapType;
+export type ProEnumProps = ProEnumBaseType;
 export {};

package/es/ProEnum/propsType.js

@@ -1,7 +1 @@
-var proEnum = {
-  code: '22',
-  showCodeName: true,
-  value: 1,
-  type: 'Group'
-};
 export {};

package/es/ProEnum/utils/index.d.ts

@@ -6,7 +6,7 @@ interface EnumRes {
 }
 export declare function getEnumData(storage: StorageType, cacheKey: string, baseEnumStorage?: any): EnumRes;
 export declare function setEnumData(storage: StorageType, cacheKey: string, data: any): boolean;
-export declare function hasEnumList(storage: StorageType, cacheKey: any, code: string): DataOption[];
+export declare function hasEnumList(storage: StorageType, cacheKey: any, code: string): import("../propsType").DataOptionType[];
 export declare function isObject(obj: any): boolean;
 export declare function mergeCacheData(storage: string, code: string, cacheKey: string, responseData: any): void;
 /**

package/es/ProForm/components/FormFooter/index.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { FooterRenderProps } from './propsType';
+import { FooterRenderType } from './propsType';
 export declare const PRO_FORM_CACHE = "PRO_FORM_CACHE";
-declare const FormFooter: React.FC<FooterRenderProps>;
+declare const FormFooter: React.FC<FooterRenderType>;
 export default FormFooter;

package/es/ProForm/components/FormFooter/propsType.d.ts

@@ -2,18 +2,23 @@ import { ButtonProps, ColProps, FormInstance } from 'antd';
 export interface ButtonItem extends ButtonProps {
     children?: any;
 }
-export interface FooterButtonProps {
+export interface FooterButtonType {
     okButtonProps?: ButtonItem;
     cancelButtonProps?: ButtonItem;
 }
-export interface FooterRenderProps {
+export interface FooterRenderType {
     okText?: string;
     cancelText?: string;
     onOk?: () => void;
     onCancel?: () => void;
     footerColProps?: ColProps;
-    footer?: FooterButtonProps;
+    footer?: FooterButtonType;
     confirmLoading?: boolean;
     formId?: string;
     form: FormInstance;
 }
+/**
+ * 兼容旧命名导出
+ */
+export type FooterButtonProps = FooterButtonType;
+export type FooterRenderProps = FooterRenderType;

package/es/ProForm/components/base/Checkbox/index.d.ts

@@ -1,13 +1,13 @@
 import React from 'react';
 import { CheckboxGroupProps } from 'antd/es/checkbox';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<CheckboxGroupProps, 'options'> {
     dataSource: any[];
     fieldNames?: {
         label: string;
         value: string;
     };
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Checkbox: React.FC<Props>;

package/es/ProForm/components/base/Input/index.d.ts

@@ -1,3 +1,3 @@
-import { IProps } from './propsType';
-declare const Input: (props: IProps) => import("react/jsx-runtime").JSX.Element;
+import { Props } from './propsType';
+declare const Input: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default Input;

package/es/ProForm/components/base/Input/propsType.d.ts

@@ -1,7 +1,7 @@
 import { InputProps } from 'antd';
 import { FormInstance } from 'antd/es/form/Form';
-import { ProFormOtherProps } from '../../../propsType';
-export interface ProFieldProps<T = any> {
+import { ProFormOtherType } from '../../../propsType';
+export interface ProFieldType<T = any> {
     from?: FormInstance<T>;
     label?: string;
     name?: string;
@@ -9,9 +9,13 @@ export interface ProFieldProps<T = any> {
     fieldName?: string;
     placeholder?: string;
 }
-export interface IProps extends InputProps, ProFieldProps {
-    otherProps?: ProFormOtherProps;
+export interface Props extends InputProps, ProFieldType {
+    otherProps?: ProFormOtherType;
     isView?: boolean;
     /** 脱敏数据位置下标 */
     desensitization?: [number, number];
 }
+/**
+ * 兼容旧命名导出
+ */
+export type ProFieldProps<T = any> = ProFieldType<T>;

package/es/ProForm/components/base/InputNumber/index.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import { InputNumberProps } from 'antd';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<InputNumberProps, 'onBlur'> {
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     range?: string;
     onBlur?: (value?: number, record?: any, object?: any) => void;
     isView?: boolean;

package/es/ProForm/components/base/Radio/index.d.ts

@@ -1,6 +1,6 @@
 import { RadioChangeEvent, RadioProps } from 'antd';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<RadioProps, 'options' | 'onChange'> {
     dataSource: any[];
     onChange: (value: any, e: RadioChangeEvent) => void;
@@ -8,7 +8,7 @@ export interface Props extends Omit<RadioProps, 'options' | 'onChange'> {
         label: string;
         value: string;
     };
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Radio: React.FC<Props>;

package/es/ProForm/components/base/RangePicker/index.d.ts

@@ -1,9 +1,9 @@
 import type { RangePickerProps } from 'antd/es/date-picker';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 import { Props as RangeProps } from './useDateRange';
 export type Props = {
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     separator?: any;
     showTime?: any;
     isView?: boolean;

package/es/ProForm/components/base/Select/index.d.ts

@@ -1,10 +1,10 @@
 import { SelectProps } from 'antd';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends SelectProps {
     dataSource?: any[];
     scrollFollowParent?: boolean;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Select: React.FC<Props>;

package/es/ProForm/components/base/Switch/index.d.ts

@@ -1,9 +1,9 @@
 import { SwitchProps } from 'antd';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends Omit<SwitchProps, 'value'> {
     value: any;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const Switch: React.FC<Props>;

package/es/ProForm/components/base/SwitchCheckbox/index.d.ts

@@ -1,9 +1,9 @@
 import * as React from 'react';
 import { CheckboxProps } from 'antd';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 export interface Props extends CheckboxProps {
     label?: string;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const SwitchCheckbox: React.FC<Props>;

package/es/ProForm/components/base/TextArea/index.d.ts

@@ -1,9 +1,9 @@
 import { TextAreaProps } from 'antd/es/input';
 import React from 'react';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 import './index.less';
 export interface Props extends TextAreaProps {
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
     tooltip?: boolean;
 }

package/es/ProForm/components/base/TimePicker/index.d.ts

@@ -1,13 +1,13 @@
 import React from 'react';
 import type { TimePickerProps } from 'antd/es/time-picker';
-import { ProFormOtherProps } from '../../../propsType';
+import { ProFormOtherType } from '../../../propsType';
 import './style/index.less';
 export interface Props {
     valueType?: string;
     format?: string;
     onChange?: (value: string) => void;
     value?: string;
-    otherProps?: ProFormOtherProps;
+    otherProps?: ProFormOtherType;
     isView?: boolean;
 }
 declare const TimePicker: React.FC<Props & TimePickerProps>;

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

@@ -1,4 +1,4 @@
 import React from 'react';
-import { ContainerProps } from './propsType';
-declare const Container: React.FC<ContainerProps>;
+import { ContainerType } from './propsType';
+declare const Container: React.FC<ContainerType>;
 export default Container;

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

@@ -1,13 +1,17 @@
 import React from 'react';
 import { RowProps } from 'antd';
-import { ProColumnProps, ProFormOtherProps, DiffConfigProps } from '../../../propsType';
-export interface ContainerProps {
-    children?: ProColumnProps[];
-    otherProps?: ProFormOtherProps;
+import { ProColumnType, ProFormOtherType, DiffConfigType } from '../../../propsType';
+export interface ContainerType {
+    children?: ProColumnType[];
+    otherProps?: ProFormOtherType;
     rowProps?: RowProps;
     className?: string;
     container?: string | React.ReactNode;
     show?: boolean | (() => boolean);
-    diffConfig?: DiffConfigProps;
+    diffConfig?: DiffConfigType;
     clearNotShow?: boolean;
 }
+/**
+ * 兼容旧命名导出
+ */
+export type ContainerProps = ContainerType;

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

@@ -1,11 +1,11 @@
 import { FormInstance, FormListFieldData, FormListOperation } from 'antd';
 import { InternalNamePath } from 'antd/es/form/interface';
 import React from 'react';
-import { FormListProps, ActionProps, FormListMode } from '../propsType';
+import { FormListType, ActionType, FormListMode } from '../propsType';
 export interface Props {
-    min?: FormListProps['min'];
-    max?: FormListProps['max'];
-    actionProps: ActionProps[];
+    min?: FormListType['min'];
+    max?: FormListType['max'];
+    actionProps: ActionType[];
     namePath: InternalNamePath;
     form: FormInstance;
     field: Omit<FormListFieldData, 'key'> & {

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

@@ -2,9 +2,9 @@ import { ColProps, FormListFieldData } from 'antd';
 import React from 'react';
 import { InternalNamePath } from 'antd/es/form/interface';
 import type { levelType } from '../../../../../ProLayout/components/ProCollapse/PropTypes';
-import type { FormListProps } from '../propsType';
-import { DiffConfigProps } from '../../../../propsType';
-interface Props extends Omit<FormListProps, 'toolbarProps'> {
+import type { FormListType } from '../propsType';
+import { DiffConfigType } from '../../../../propsType';
+interface Props extends Omit<FormListType, 'toolbarProps'> {
     index: number;
     namePath: InternalNamePath;
     disabled?: boolean;
@@ -15,7 +15,7 @@ interface Props extends Omit<FormListProps, 'toolbarProps'> {
     };
     level?: levelType;
     towCollapse?: boolean;
-    diffConfig?: DiffConfigProps;
+    diffConfig?: DiffConfigType;
 }
 declare const BlockFields: React.FC<Props>;
 export default BlockFields;

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

@@ -1,9 +1,9 @@
 import { ColProps, FormListFieldData } from 'antd';
 import React from 'react';
 import { InternalNamePath } from 'antd/es/form/interface';
-import { FormListProps } from '../propsType';
-import { DiffConfigProps } from '../../../../propsType';
-interface Props extends Omit<FormListProps, 'toolbarProps'> {
+import { FormListType } from '../propsType';
+import { DiffConfigType } from '../../../../propsType';
+interface Props extends Omit<FormListType, 'toolbarProps'> {
     className?: string;
     index: number;
     namePath: InternalNamePath;
@@ -13,7 +13,7 @@ interface Props extends Omit<FormListProps, 'toolbarProps'> {
     field: Omit<FormListFieldData, 'key'> & {
         key: string;
     };
-    diffConfig?: DiffConfigProps;
+    diffConfig?: DiffConfigType;
 }
 declare const LineFields: React.FC<Props>;
 export default LineFields;

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

@@ -1,9 +1,9 @@
 import { InternalNamePath } from 'antd/es/form/interface';
 import React from 'react';
-import { ToolbarActionProps } from '../propsType';
+import { ToolbarActionType } from '../propsType';
 import { Props as ActionButtonProps } from './ActionButton';
 interface Props extends Omit<ActionButtonProps, 'actionProps' | 'field' | 'index' | 'mode' | 'namePath'> {
-    toolbarProps: ToolbarActionProps[];
+    toolbarProps: ToolbarActionType[];
     namePath: InternalNamePath;
     disabled?: boolean;
     isView?: boolean;

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

@@ -1,4 +1,4 @@
 import React from 'react';
-import type { FormListRef, FormListProps } from './propsType';
-declare const _default: React.ForwardRefExoticComponent<FormListProps & React.RefAttributes<FormListRef>>;
+import type { FormListRefType, FormListType } from './propsType';
+declare const _default: React.ForwardRefExoticComponent<FormListType & React.RefAttributes<FormListRefType>>;
 export default _default;