@faasjs/ant-design 0.0.3-beta.5 → 0.0.3-beta.51

package/dist/index.d.ts

@@ -1,20 +1,26 @@
 import * as react from 'react';
-import { CSSProperties, ReactNode, LazyExoticComponent, ComponentType } from 'react';
-import { ConfigProviderProps as ConfigProviderProps$1 } from 'antd/es/config-provider';
+import { CSSProperties, ReactNode, ReactElement, Component, LazyExoticComponent, ComponentType } from 'react';
 import { Dayjs } from 'dayjs';
-import { DescriptionsProps, DrawerProps as DrawerProps$1, FormItemProps as FormItemProps$1, FormInstance, InputProps, InputNumberProps, SwitchProps, DatePickerProps, TimePickerProps, SelectProps, FormProps as FormProps$1, ButtonProps, ModalProps as ModalProps$1, TableColumnProps, TablePaginationConfig, TableProps as TableProps$1 } from 'antd';
+import { FormItemProps as FormItemProps$1, InputProps, InputNumberProps, SwitchProps, SelectProps, DatePickerProps, TimePickerProps, FormInstance, DescriptionsProps, TableColumnProps, TablePaginationConfig, TableProps as TableProps$1, DrawerProps as DrawerProps$1, FormProps as FormProps$1, ButtonProps, ModalProps as ModalProps$1 } from 'antd';
 export { Drawer, Modal } from 'antd';
-import { FaasDataWrapperProps } from '@faasjs/react';
-import * as antd_es_form_Form from 'antd/es/form/Form';
 import { RuleObject } from 'rc-field-form/lib/interface';
-import { RouteProps } from 'react-router-dom';
+import { FaasDataInjection as FaasDataInjection$1, FaasDataWrapperProps as FaasDataWrapperProps$1 } from '@faasjs/react';
 import { FilterValue, SorterResult, TableCurrentDataSource } from 'antd/es/table/interface';
+import * as antd_es_form_context from 'antd/es/form/context';
+import * as antd_es_form_ErrorList from 'antd/es/form/ErrorList';
+import * as antd_es_form from 'antd/es/form';
+import * as rc_field_form_es_useWatch from 'rc-field-form/es/useWatch';
+import * as antd_es_form_hooks_useFormInstance from 'antd/es/form/hooks/useFormInstance';
+import * as antd_es_form_Form from 'antd/es/form/Form';
+import { RouteProps } from 'react-router-dom';
 
-type BlankProps = {
+interface BlankProps {
     value?: any;
     text?: string;
-};
+}
 /**
+ * Blank component.
+ *
  * If value is undefined or null, return text, otherwise return value.
  *
  * @param options {object}
@@ -28,8 +34,7 @@ type BlankProps = {
  */
 declare function Blank(options?: BlankProps): JSX.Element;
 
-type ConfigProviderProps = {
-    antd?: ConfigProviderProps$1;
+interface ConfigProviderProps {
     lang?: string;
     common?: {
         blank?: string;
@@ -60,7 +65,7 @@ type ConfigProviderProps = {
         target?: string;
         style?: CSSProperties;
     };
-};
+}
 declare const ConfigContext: react.Context<ConfigProviderProps>;
 /**
  * Config for @faasjs/ant-design components.
@@ -81,6 +86,161 @@ declare function ConfigProvider({ config, children }: {
 }): JSX.Element;
 declare function useConfigContext(): ConfigProviderProps;
 
+type ExtendFormTypeProps<T = any> = {
+    children?: UnionFaasItemElement<T>;
+};
+type ExtendTypes = {
+    [type: string]: ExtendFormTypeProps;
+};
+type ExtendFormItemProps = BaseItemProps & FormItemProps$1;
+interface FormItemProps<T = any> extends FaasItemProps, Omit<FormItemProps$1<T>, 'id' | 'children' | 'render'> {
+    input?: InputProps | InputNumberProps | SwitchProps | SelectProps<T> | DatePickerProps | TimePickerProps;
+    maxCount?: number;
+    object?: FormItemProps[];
+    disabled?: boolean;
+    required?: boolean;
+    col?: number;
+    children?: UnionFaasItemElement<T>;
+    formChildren?: UnionFaasItemElement<T>;
+    render?: UnionFaasItemRender<T>;
+    formRender?: UnionFaasItemRender<T>;
+    rules?: RuleObject[];
+    label?: string | false;
+    extendTypes?: ExtendTypes;
+    /** trigger when current item's value changed */
+    onValueChange?: (value: T, values: any, form: FormInstance) => void;
+    /** trigger when any item's value changed */
+    if?: (values: Record<string, any>) => boolean;
+}
+/**
+ * FormItem, can be used without Form.
+ *
+ * ```ts
+ * // use inline type
+ * <FormItem type='string' id='name' />
+ *
+ * // use custom type
+ * <FormItem id='password'>
+ *   <Input.Password />
+ * </>
+ * ```
+ */
+declare function FormItem<T = any>(props: FormItemProps<T>): JSX.Element;
+declare namespace FormItem {
+    var useStatus: () => {
+        status?: "" | "warning" | "error" | "success" | "validating";
+    };
+}
+
+type LoadingProps = {
+    style?: React.CSSProperties;
+    size?: 'small' | 'default' | 'large';
+    loading?: boolean;
+    children?: React.ReactNode;
+};
+/**
+ * Loading component based on Spin
+ *
+ * ```tsx
+ * <Loading /> // display loading
+ *
+ * <Loading loading={ !remoteData }>
+ *  <div>{remoteData}</div>
+ * </Loading>
+ * ```
+ */
+declare function Loading(props: LoadingProps): JSX.Element;
+
+type FaasDataInjection<T = any> = Partial<FaasDataInjection$1<T>>;
+interface FaasDataWrapperProps<T = any> extends FaasDataWrapperProps$1<T> {
+    loadingProps?: LoadingProps;
+    loading?: JSX.Element;
+}
+/**
+ * FaasDataWrapper component with Loading
+ *
+ * ```tsx
+ * function MyComponent (props: FaasDataInjection) {
+ *   return <div>{ props.data }</div>
+ * }
+ *
+ * function MyPage () {
+ *   return <FaasDataWrapper action="test" params={{ a: 1 }}>
+ *     <MyComponent />
+ *   </FaasDataWrapper>
+ * }
+ * ```
+ */
+declare function FaasDataWrapper<T = any>(props: FaasDataWrapperProps<T>): JSX.Element;
+
+interface ExtendDescriptionTypeProps<T = any> {
+    children?: UnionFaasItemElement<T>;
+    render?: UnionFaasItemRender<T>;
+}
+type ExtendDescriptionItemProps = BaseItemProps;
+interface DescriptionItemProps<T = any> extends FaasItemProps {
+    children?: UnionFaasItemElement<T>;
+    descriptionChildren?: UnionFaasItemElement<T>;
+    render?: UnionFaasItemRender<T>;
+    descriptionRender?: UnionFaasItemRender<T>;
+    if?: (values: Record<string, any>) => boolean;
+    object?: DescriptionItemProps<T>[];
+}
+interface DescriptionProps<T = any, ExtendItemProps = any> extends DescriptionsProps {
+    renderTitle?: ((values: T) => ReactNode);
+    items: (DescriptionItemProps | ExtendItemProps)[];
+    extendTypes?: {
+        [key: string]: ExtendDescriptionTypeProps;
+    };
+    dataSource?: T;
+    faasData?: FaasDataWrapperProps<T>;
+}
+interface DescriptionItemContentProps<T = any> {
+    item: DescriptionItemProps;
+    value: T;
+    values?: any;
+    extendTypes?: {
+        [key: string]: ExtendDescriptionTypeProps;
+    };
+}
+/**
+ * Description component.
+ */
+declare function Description<T = any>(props: DescriptionProps<T>): JSX.Element;
+
+interface TableItemProps<T = any> extends FaasItemProps, Omit<TableColumnProps<T>, 'title' | 'children' | 'render'> {
+    optionsType?: 'auto';
+    children?: UnionFaasItemElement<T>;
+    tableChildren?: UnionFaasItemElement<T>;
+    render?: UnionFaasItemRender<T>;
+    tableRender?: UnionFaasItemRender<T>;
+    object?: TableItemProps<T>[];
+}
+type ExtendTableTypeProps<T = any> = {
+    children?: JSX.Element;
+    render?: UnionFaasItemRender<T>;
+};
+type ExtendTableItemProps<T = any> = BaseItemProps & Omit<TableColumnProps<T>, 'children'>;
+type TableProps<T = any, ExtendTypes = any> = {
+    items: (TableItemProps | (ExtendTypes & ExtendTableItemProps))[];
+    extendTypes?: {
+        [key: string]: ExtendTableTypeProps;
+    };
+    faasData?: FaasDataWrapperProps<T>;
+    onChange?: (pagination: TablePaginationConfig, filters: Record<string, FilterValue | null>, sorter: SorterResult<T> | SorterResult<T>[], extra: TableCurrentDataSource<T>) => {
+        pagination: TablePaginationConfig;
+        filters: Record<string, FilterValue | null>;
+        sorter: SorterResult<T> | SorterResult<T>[];
+        extra: TableCurrentDataSource<T>;
+    };
+} & TableProps$1<T>;
+/**
+ * Table component with Ant Design & FaasJS
+ *
+ * @ref https://ant.design/components/table/
+ */
+declare function Table<T extends Record<string, any>, ExtendTypes = any>(props: TableProps<T, ExtendTypes>): JSX.Element;
+
 type FaasItemType = 'string' | 'string[]' | 'number' | 'number[]' | 'boolean' | 'date' | 'time' | 'object' | 'object[]';
 /** FaasItemType's value type */
 type FaasItemTypeValue = {
@@ -98,53 +258,48 @@ type BaseOption = string | number | {
     label: string;
     value?: string | number;
 };
-type BaseItemProps = {
+interface BaseItemProps {
     id: string;
     title?: string;
     options?: BaseOption[];
-};
-type FaasItemProps = BaseItemProps & {
+}
+interface FaasItemProps extends BaseItemProps {
     /**
-     * Support string, string[], number, number[], boolean
+     * Support string, string[], number, number[], boolean, date, time, object, object[]
      * @default 'string'
      */
     type?: FaasItemType;
-};
+}
+/**
+ * convert options to { label, value }[]
+ */
 declare function transferOptions(options: BaseOption[]): {
     label: string;
     value?: string | number;
 }[];
 declare function transferValue(type: FaasItemType, value: any): any;
-
-type ExtendDescriptionTypeProps = {
-    children?: JSX.Element | null;
-    render?: (value: any, values: any) => ReactNode | JSX.Element;
-};
-type ExtendDescriptionItemProps = BaseItemProps;
-type DescriptionItemProps<T = any> = {
-    children?: JSX.Element;
-    render?: (value: T, values: any) => ReactNode | JSX.Element;
-    if?: (values: Record<string, any>) => boolean;
-} & FaasItemProps & {
-    object?: DescriptionItemProps[];
+type UnionScene = 'form' | 'description' | 'table';
+type UnionFaasItemInjection<Value = any, Values = any> = {
+    scene?: UnionScene;
+    value?: Value;
+    values?: Values;
+    index?: number;
 };
-type DescriptionProps<T = any, ExtendItemProps = any> = {
-    renderTitle?: ((values: T) => ReactNode | JSX.Element);
-    items: (DescriptionItemProps | ExtendItemProps)[];
-    extendTypes?: {
-        [key: string]: ExtendDescriptionTypeProps;
-    };
-    dataSource?: T;
-    faasData?: FaasDataWrapperProps<T>;
-} & DescriptionsProps;
-declare function Description<T = any>(props: DescriptionProps<T>): JSX.Element;
+type UnionFaasItemRender<Value = any, Values = any> = (value: Value, values: Values, index: number, scene: UnionScene) => JSX.Element | null;
+type UnionFaasItemElement<Value = any, Values = any> = ReactElement<UnionFaasItemInjection<Value, Values>> | null;
+interface UnionFaasItemProps<Value = any, Values = any> extends FormItemProps, DescriptionItemProps, TableItemProps {
+    children?: UnionFaasItemElement<UnionFaasItemProps<Value, Values>> | null;
+    render?: UnionFaasItemRender;
+    object?: UnionFaasItemProps<Value, Values>[];
+}
 
-type DrawerProps = DrawerProps$1 & {
+interface DrawerProps extends DrawerProps$1 {
     children?: JSX.Element | JSX.Element[];
-};
+}
 type setDrawerProps = (changes: Partial<DrawerProps>) => void;
 /**
  * Hook style drawer.
+ *
  * @param init initial props
  *
  * ```ts
@@ -166,134 +321,71 @@ declare function useDrawer(init?: DrawerProps): {
     setDrawerProps(changes: Partial<DrawerProps>): void;
 };
 
-type StringProps = {
-    type?: 'string';
-    input?: InputProps;
-};
-type StringListProps = {
-    type: 'string[]';
-    input?: InputProps;
-    maxCount?: number;
-};
-type NumberProps = {
-    type: 'number';
-    input?: InputNumberProps;
-};
-type NumberListProps = {
-    type: 'number[]';
-    input?: InputNumberProps;
-    maxCount?: number;
-};
-type BooleanProps = {
-    type: 'boolean';
-    input?: SwitchProps;
-};
-type DateProps = {
-    type: 'date';
-    input?: DatePickerProps;
-};
-type TimeProps = {
-    type: 'time';
-    input?: TimePickerProps;
-};
-type ObjectProps = {
-    type: 'object';
-    object: FormItemProps[];
-};
-type ObjectListProps = {
-    type: 'object[]';
-    object: (FormItemProps & {
-        /** default is 6 */
-        col?: number;
-    })[];
-    maxCount?: number;
-};
-type OptionsProps = {
-    options?: BaseOption[];
-    type?: 'string' | 'string[]' | 'number' | 'number[]';
-    input?: SelectProps<any>;
-};
-type FormItemInputProps = (StringProps | StringListProps | NumberProps | NumberListProps | BooleanProps | OptionsProps | DateProps | TimeProps | ObjectProps | ObjectListProps) & {
-    disabled?: boolean;
-    required?: boolean;
-};
-type ExtendFormTypeProps = {
-    children?: ReactNode;
-};
-type ExtendTypes = {
-    [type: string]: ExtendFormTypeProps;
-};
-type ExtendFormItemProps = BaseItemProps & FormItemProps$1;
-type FormItemProps<T = any> = {
+interface ErrorBoundaryProps {
+    message?: ReactNode;
+    description?: ReactNode;
     children?: ReactNode;
-    render?: (value?: T) => ReactNode | JSX.Element;
-    rules?: RuleObject[];
-    label?: string | false;
-    extendTypes?: ExtendTypes;
-    /** trigger when current item's value changed */
-    onValueChange?: (value: T, values: any, form: FormInstance) => void;
-    /** trigger when any item's value changed */
-    if?: (values: Record<string, any>) => boolean;
-} & FormItemInputProps & FaasItemProps & Omit<FormItemProps$1<T>, 'children'>;
-/**
- * FormItem, can be used without Form.
- *
- * ```ts
- * // use inline type
- * <FormItem type='string' id='name' />
- *
- * // use custom type
- * <FormItem id='password'>
- *   <Input.Password />
- * </>
- * ```
- */
-declare function FormItem<T = any>(props: FormItemProps<T>): JSX.Element;
+    onError?: (error: Error | null, info: any) => ReactNode;
+}
+declare class ErrorBoundary extends Component<ErrorBoundaryProps, {
+    error?: Error | null;
+    info?: {
+        componentStack?: string;
+    };
+}> {
+    constructor(props: ErrorBoundaryProps);
+    componentDidCatch(error: Error | null, info: any): void;
+    render(): string | number | boolean | react.ReactFragment | JSX.Element;
+}
 
-type FormProps<Values extends Record<string, any> = any, ExtendItemProps = any> = {
+type FormSubmitProps = {
+    /** Default: Submit */
+    text?: string;
+    /**
+     * Submit to FaasJS server.
+     *
+     * If use onFinish, you should call submit manually.
+     * ```ts
+     * {
+     *   submit: {
+     *     to: {
+     *       action: 'action_name'
+     *     }
+     *   },
+     *   onFinish: (values, submit) => {
+     *     // do something before submit
+     *
+     *     // submit
+     *     await submit({
+     *      ...values,
+     *      extraProps: 'some extra props'
+     *     })
+     *
+     *     // do something after submit
+     *   }
+     * }
+     * ```
+     */
+    to?: {
+        action: string;
+        /** params will overwrite form values before submit */
+        params?: Record<string, any>;
+        then?: (result: any) => void;
+        catch?: (error: any) => void;
+        finally?: () => void;
+    };
+};
+interface FormProps<Values extends Record<string, any> = any, ExtendItemProps = any> extends Omit<FormProps$1<Values>, 'onFinish' | 'children' | 'initialValues'> {
     items?: (FormItemProps | ExtendItemProps | JSX.Element)[];
     /** Default: { text: 'Submit' }, set false to disable it */
-    submit?: false | {
-        /** Default: Submit */
-        text?: string;
-        /**
-         * Submit to FaasJS server.
-         *
-         * If use onFinish, you should call submit manually.
-         * ```ts
-         * {
-         *   submit: {
-         *     to: {
-         *       action: 'action_name'
-         *     }
-         *   },
-         *   onFinish: (values, submit) => {
-         *     // do something before submit
-         *
-         *     // submit
-         *     await submit({
-         *      ...values,
-         *      extraProps: 'some extra props'
-         *     })
-         *
-         *     // do something after submit
-         *   }
-         * }
-         * ```
-         */
-        to?: {
-            action: string;
-            /** params will overwrite form values before submit */
-            params?: Record<string, any>;
-        };
-    };
+    submit?: false | FormSubmitProps;
     onFinish?: (values: Values, submit?: (values: any) => Promise<any>) => Promise<any>;
     beforeItems?: JSX.Element | JSX.Element[];
     footer?: JSX.Element | JSX.Element[];
     extendTypes?: ExtendTypes;
     children?: ReactNode;
     initialValues?: Values;
-} & Omit<FormProps$1<Values>, 'onFinish' | 'children' | 'initialValues'>;
+}
 /**
  * Form component with Ant Design & FaasJS
  *
@@ -302,30 +394,39 @@ type FormProps<Values extends Record<string, any> = any, ExtendItemProps = any>
 declare function Form<Values = any>(props: FormProps<Values>): JSX.Element;
 declare namespace Form {
     var useForm: typeof antd_es_form_Form.useForm;
+    var useFormInstance: typeof antd_es_form_hooks_useFormInstance.default;
+    var useWatch: typeof rc_field_form_es_useWatch.default;
+    var Item: typeof FormItem;
+    var List: react.FC<antd_es_form.FormListProps>;
+    var ErrorList: typeof antd_es_form_ErrorList.default;
+    var Provider: react.FC<antd_es_form_context.FormProviderProps>;
 }
 
-type LinkProps = {
+interface LinkProps {
     href: string;
     target?: string;
     text?: string | number;
     children?: ReactNode;
     style?: CSSProperties;
     button?: ButtonProps;
-};
+    block?: boolean;
+}
 /**
+ * Link component with button.
+ *
  * ```ts
  * // pure link
  * <Link href="/">Home</Link>
  *
  * // link with button
- * <Link href="/" button={{type:'primary'}}>Home</Link>
+ * <Link href="/" button={{ type:'primary' }}>Home</Link>
  * ```
  */
-declare function Link({ href, target, text, children, style, button, }: LinkProps): JSX.Element;
+declare function Link(props: LinkProps): JSX.Element;
 
-type ModalProps = ModalProps$1 & {
+interface ModalProps extends ModalProps$1 {
     children?: JSX.Element | JSX.Element[] | string;
-};
+}
 type setModalProps = (changes: Partial<ModalProps>) => void;
 /**
  * Hook style modal.
@@ -348,13 +449,13 @@ declare function useModal(init?: ModalProps): {
 };
 
 declare function PageNotFound(): JSX.Element;
-type RoutesProps = {
+interface RoutesProps {
     routes: (RouteProps & {
         page?: LazyExoticComponent<ComponentType<any>>;
     })[];
     fallback?: JSX.Element;
     notFound?: JSX.Element;
-};
+}
 /**
  * Routes with lazy loading and 404 page.
  *
@@ -376,38 +477,7 @@ type RoutesProps = {
  */
 declare function Routes(props: RoutesProps): JSX.Element;
 
-type TableItemProps<T = any> = {
-    optionsType?: 'auto';
-    /** @deprecated use render */
-    children?: JSX.Element | null;
-    object?: TableItemProps[];
-} & FaasItemProps & Omit<TableColumnProps<T>, 'children'>;
-type ExtendTableTypeProps = {
-    children?: JSX.Element | null;
-    render?: (value: any, values: any, index: number) => JSX.Element | string | number | boolean | null;
-};
-type ExtendTableItemProps<T = any> = BaseItemProps & Omit<TableColumnProps<T>, 'children'>;
-type TableProps<T = any, ExtendTypes = any> = {
-    items: (TableItemProps | (ExtendTypes & ExtendTableItemProps))[];
-    extendTypes?: {
-        [key: string]: ExtendTableTypeProps;
-    };
-    faasData?: FaasDataWrapperProps<T>;
-    onChange?: (pagination: TablePaginationConfig, filters: Record<string, FilterValue | null>, sorter: SorterResult<T> | SorterResult<T>[], extra: TableCurrentDataSource<T>) => {
-        pagination: TablePaginationConfig;
-        filters: Record<string, FilterValue | null>;
-        sorter: SorterResult<T> | SorterResult<T>[];
-        extra: TableCurrentDataSource<T>;
-    };
-} & TableProps$1<T>;
-/**
- * Table component with Ant Design & FaasJS
- *
- * @ref https://ant.design/components/table/
- */
-declare function Table<T = any, ExtendTypes = any>(props: TableProps<T, ExtendTypes>): JSX.Element;
-
-type TitleProps = {
+interface TitleProps {
     title: string | string[];
     /** ` - ` as default */
     separator?: string;
@@ -421,7 +491,7 @@ type TitleProps = {
     plain?: boolean;
     /** return children */
     children?: JSX.Element;
-};
+}
 /**
  * Title is used to change the title of the page.
  * Return null by default.
@@ -441,4 +511,4 @@ type TitleProps = {
  */
 declare function Title(props: TitleProps): JSX.Element;
 
-export { BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, DescriptionItemProps, DescriptionProps, DrawerProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, ExtendFormItemProps, ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasItemProps, FaasItemType, FaasItemTypeValue, Form, FormItem, FormItemProps, FormProps, Link, LinkProps, ModalProps, PageNotFound, Routes, RoutesProps, Table, TableItemProps, TableProps, Title, TitleProps, setDrawerProps, setModalProps, transferOptions, transferValue, useConfigContext, useDrawer, useModal };
+export { BaseItemProps, BaseOption, Blank, BlankProps, ConfigContext, ConfigProvider, ConfigProviderProps, Description, DescriptionItemContentProps, DescriptionItemProps, DescriptionProps, DrawerProps, ErrorBoundary, ErrorBoundaryProps, ExtendDescriptionItemProps, ExtendDescriptionTypeProps, ExtendFormItemProps, ExtendFormTypeProps, ExtendTableItemProps, ExtendTableTypeProps, ExtendTypes, FaasDataInjection, FaasDataWrapper, FaasDataWrapperProps, FaasItemProps, FaasItemType, FaasItemTypeValue, Form, FormItem, FormItemProps, FormProps, FormSubmitProps, Link, LinkProps, Loading, LoadingProps, ModalProps, PageNotFound, Routes, RoutesProps, Table, TableItemProps, TableProps, Title, TitleProps, UnionFaasItemElement, UnionFaasItemInjection, UnionFaasItemProps, UnionFaasItemRender, UnionScene, setDrawerProps, setModalProps, transferOptions, transferValue, useConfigContext, useDrawer, useModal };