@zy-frontend/form-core 2.0.6

package/dist/index.es.d.ts

@@ -0,0 +1,453 @@
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { InjectionKey } from 'vue';
+import { PropType } from 'vue';
+import { PublicProps } from 'vue';
+import { Ref } from 'vue';
+import { RuleItem } from 'async-validator';
+import { Rules } from 'async-validator';
+import { RuleType } from 'async-validator';
+import { UnwrapNestedRefs } from 'vue';
+
+declare type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+
+declare type __VLS_NonUndefinedable_2<T> = T extends undefined ? never : T;
+
+declare type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare type __VLS_Prettify_2<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
+declare type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_TypePropsToRuntimeProps_2<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: PropType<__VLS_NonUndefinedable_2<T[K]>>;
+    } : {
+        type: PropType<T[K]>;
+        required: true;
+    };
+};
+
+declare type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
+declare type __VLS_WithDefaults_2<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify_2<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
+export declare type Action = {
+    name?: string;
+    immediate?: boolean;
+    handler: string | ActionHandler | CombinedActionHandler;
+};
+
+export declare type ActionHandler = (fieldValue: any, // 当前字段的值
+formKey: string, // 当前表单key
+formData: Record<string, any>, // 当前所有表单数据
+formConfig: Record<string, FormWithFieldMap>, // 所有表单配置的Map
+oldFieldValue: any) => void;
+
+export declare type AdvancedConfig = {
+    skipAutoDataReset?: boolean;
+};
+
+export declare type CombinedActionHandler = (formKey: string, // 当前表单key
+formData: Record<string, any>, // 当前所有表单数据
+formConfig: Record<string, FormWithFieldMap>) => void;
+
+export declare interface Component {
+    type: ComponentType;
+    props?: Record<string, any>;
+    options?: Option_2[];
+    remote?: ComponentRemote | boolean;
+    showWhenReadOnly?: boolean;
+    fields?: Field[];
+    [key: string]: any;
+}
+
+export declare interface ComponentRemote {
+    url?: string;
+    extraParams?: Record<string, string | number | boolean>;
+    [key: string]: any;
+}
+
+export declare type ComponentType = ComponentTypeEnum | string;
+
+export declare enum ComponentTypeEnum {
+    Input = "input",
+    InputNumber = "inputNumber",
+    Select = "select",
+    MultiSelect = "multiSelect",
+    Cascader = "cascader",
+    Radio = "radio",
+    Checkbox = "checkbox",
+    Switch = "switch",
+    DatePicker = "datePicker",
+    DateTimePicker = "dateTimePicker",
+    Upload = "upload",
+    DynamicTable = "dynamicTable",
+    DynamicForm = "dynamicForm",
+    DynamicTabs = "dynamicTabs",
+    Title = "title",
+    Collapse = "collapse",
+    ImageList = "imageList",
+    CombinedFields = "combinedFields"
+}
+
+export declare type ContainerFieldComponent = Component & {
+    container: {
+        className?: string;
+    };
+    anchorTab?: boolean;
+};
+
+export declare const DELETED_FIELD_IDENTIFIER = "#ZY-FORM-CORE-DELETED#";
+
+export declare interface Field {
+    key: string;
+    formKey?: string;
+    span?: number;
+    label?: Label | string;
+    description?: string;
+    props?: Record<string, any>;
+    type: FieldType;
+    defaultValue?: any;
+    clearValue?: any;
+    show?: boolean;
+    disabled?: boolean | IsFieldDisabled | string;
+    rules?: Rule[];
+    component?: Component;
+    actions?: Array<Action | ActionHandler | string>;
+    subscribers?: Subscriber[];
+    datetimeFormatPattern?: string;
+    className?: string;
+    advancedConfig?: AdvancedConfig;
+    readonly?: boolean;
+    [key: string]: any;
+}
+
+export declare type FieldType = 'boolean' | 'string' | 'number' | 'array' | 'object' | 'datetime' | 'images' | 'null' | 'container' | 'invisible' | 'combined';
+
+export declare type FileRemoveMethod = (componentParams?: Record<string, any>, context?: RequestContext) => Promise<void> | void;
+
+export declare interface Form {
+    key: string;
+    title?: string;
+    props?: FormProps;
+    show?: boolean;
+    gutter?: FormGutter;
+    fields: Field[];
+    preScript?: string | PreScriptFunction;
+    postScript?: string | PostScriptFunction;
+    subscribers?: (Omit<Subscriber, 'handler'> & {
+        handler: FormSubscriberHandler | string;
+    })[];
+    readonly?: boolean;
+    [key: string]: any;
+}
+
+export declare const FORM_CONTEXT_SYMBOL: InjectionKey<Record<string, any>>;
+
+export declare const FORM_DATA_REFRESH_SYMBOL: InjectionKey<Ref<string, string>>;
+
+export declare const FORM_DISABLED_SYMBOL: unique symbol;
+
+export declare const FORM_GROUP_SYMBOL: unique symbol;
+
+export declare const FORM_UNFULFILLED_FIELD_SYMBOL: unique symbol;
+
+export declare type FormGutter = {
+    horizontal?: number | string;
+    vertical?: number | string;
+    [key: string]: any;
+};
+
+export declare type FormLabelPosition = LabelPosition;
+
+export declare interface FormProps {
+    labelPosition?: FormLabelPosition;
+    labelWidth?: string | number;
+    hideRequiredAsterisk?: boolean;
+    disabled?: boolean;
+    [key: string]: any;
+}
+
+export declare type FormSubscriberHandler = (depValues: any[], // 依赖项值的集合
+formKey: string, // 当前表单key
+formData: Record<string, any>, // 当前所有表单数据
+formConfig: Form) => void;
+
+export declare type FormWithFieldMap = {
+    fieldMap: Record<string, Field>;
+} & Form;
+
+export declare const getFormattedFieldValue: (fieldValue: any, fieldType: Field['type'], componentProps: {
+    datetimeFormatPattern: string;
+}) => any;
+
+export declare const IDENTIFIER = "#ZY-FORM-CORE#";
+
+export declare type IsFieldDisabled = (fieldValue: any, formData: any, fieldConfig: Field) => boolean;
+
+export declare interface Label {
+    text?: string;
+    width?: string;
+    [key: string]: any;
+}
+
+export declare type LabelPosition = 'top' | 'right' | 'left';
+
+declare type Option_2 = {
+    value: string | number | boolean | Record<string, any>;
+    label: string;
+    disabled?: boolean;
+    [key: string]: any;
+};
+export { Option_2 as Option }
+
+export declare type PostScriptFunction = (formData: Ref<Record<string, any>>, // 当前表单数据
+formConfig: UnwrapNestedRefs<Form>) => Record<string, any>;
+
+export declare type PreScriptFunction = (formData: Ref<Record<string, any>>, // 当前表单数据
+formConfig: UnwrapNestedRefs<Form>) => void;
+
+export declare type RemoteMethod = (componentParams?: Record<string, any>, context?: RequestContext) => Option_2[] | Promise<Option_2[]>;
+
+export declare type RemoteResponse = Option_2[] | Promise<Option_2[]> | any;
+
+export declare interface RequestContext {
+    requestId: number;
+    signal?: AbortSignal;
+}
+
+export declare type RequestFunction = (keyPath: string, // 字段键路径，格式为formKey.fieldKey
+value: any, // 字段值
+url?: string, // 字段remote里配置的远程请求URL
+extraParams?: Record<string, string | number | boolean>, // 字段remote里配置的远程请求参数
+componentParams?: Record<string, any>, // 由UI组件传入的参数，如Select组件的query、Upload组件的file等
+context?: RequestContext) => RemoteResponse;
+
+export declare interface Rule extends Omit<RuleItem, 'validator'> {
+    level?: number;
+    validator?: string | ValidatorFunction | Validator;
+    deps?: string[];
+    trigger?: string | string[];
+}
+
+export { RuleType }
+
+export declare interface Subscriber {
+    name?: string;
+    immediate?: boolean;
+    deps: string[];
+    handler: SubscriberHandler | string;
+}
+
+export declare type SubscriberHandler = (depValues: any[], // 依赖项值的集合
+formKey: string, // 当前表单key
+fieldKey: string, // 当前字段key
+formData: Record<string, any>, // 当前所有表单数据
+fieldConfig: Field) => void;
+
+export declare interface UIComponents extends Record<ComponentType, any> {
+    form: any;
+    formItem: any;
+    tabs?: any;
+    collapse?: any;
+    collapseItem?: any;
+    [key: string]: any;
+}
+
+export declare interface UIComponentsWithTab extends UIComponents {
+    tabs: any;
+}
+
+export declare type UnfulfilledField = {
+    key: string;
+    formKey: string;
+    label: string;
+    message: string;
+};
+
+export declare type UploadMethod = (componentParams?: Record<string, any>, context?: RequestContext) => UploadResponse;
+
+export declare type UploadResponse = any | Promise<any>;
+
+export declare const validateFields: (rules: Rules, value: Record<string, any>) => Promise<void>;
+
+export declare interface Validator {
+    name?: string;
+    required?: boolean;
+    deps?: string[];
+    handler: string | ValidatorFunction;
+}
+
+export declare type ValidatorFunction = (rule: any, value: any, callback: any, formData: UnwrapNestedRefs<Record<string, any>>, // 当前表单数据
+formConfig: UnwrapNestedRefs<Form>, // 当前表单配置
+validatorParams: {
+    rule: any;
+    value: any;
+    callback: any;
+}, formGroupData: UnwrapNestedRefs<Record<string, any>>, depValues?: any[]) => void;
+
+export declare const ZYForm: DefineComponent<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+components: UIComponents;
+config: Form[];
+data: Record<string, any>;
+formKey: string;
+activated?: boolean | undefined;
+readonly?: boolean | undefined;
+static?: boolean | undefined;
+disabled?: boolean | undefined;
+requestFn?: RequestFunction | undefined;
+scenario?: string | undefined;
+requiredFieldOnly?: boolean | undefined;
+anchorPositioning?: boolean | undefined;
+anchorTabsPlacement?: "right" | "left" | undefined;
+nestedProps?: {
+key?: string | number | undefined;
+label?: string | undefined;
+} | undefined;
+showUnfulfilledTips?: boolean | undefined;
+}>, {
+requestFn: undefined;
+scenario: undefined;
+anchorTabsPlacement: string;
+showUnfulfilledTips: boolean;
+}>>, {
+initFormData: (newData?: Record<string, any> | undefined) => Promise<void>;
+resetFormData: () => void;
+restartWatch: () => Promise<void>;
+validate: (maxLevel?: number | undefined, fields?: string[] | undefined) => Promise<true | [...any[], any]>;
+clearValidate: () => any;
+getFormData: () => any;
+showFirstUnfulfilledField: () => void;
+scrollTo: (fieldKey: string) => Promise<void>;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+blur: (e: FocusEvent, keyPath: string, fieldValue: any) => void;
+change: (keyPath: string, fieldValue: any) => void;
+keyupEnter: (e: KeyboardEvent, keyPath: string, fieldValue: any) => void;
+"update:data": (val: Record<string, any>) => void;
+"update:config": (val: Form[]) => void;
+"update:unfulfilledFields": (val: UnfulfilledField[]) => void;
+mounted: () => void;
+"data-initialed": (formKey: string) => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<{
+components: UIComponents;
+config: Form[];
+data: Record<string, any>;
+formKey: string;
+activated?: boolean | undefined;
+readonly?: boolean | undefined;
+static?: boolean | undefined;
+disabled?: boolean | undefined;
+requestFn?: RequestFunction | undefined;
+scenario?: string | undefined;
+requiredFieldOnly?: boolean | undefined;
+anchorPositioning?: boolean | undefined;
+anchorTabsPlacement?: "right" | "left" | undefined;
+nestedProps?: {
+key?: string | number | undefined;
+label?: string | undefined;
+} | undefined;
+showUnfulfilledTips?: boolean | undefined;
+}>, {
+requestFn: undefined;
+scenario: undefined;
+anchorTabsPlacement: string;
+showUnfulfilledTips: boolean;
+}>>> & Readonly<{
+onBlur?: ((e: FocusEvent, keyPath: string, fieldValue: any) => any) | undefined;
+onChange?: ((keyPath: string, fieldValue: any) => any) | undefined;
+onKeyupEnter?: ((e: KeyboardEvent, keyPath: string, fieldValue: any) => any) | undefined;
+"onUpdate:data"?: ((val: Record<string, any>) => any) | undefined;
+"onUpdate:config"?: ((val: Form[]) => any) | undefined;
+"onUpdate:unfulfilledFields"?: ((val: UnfulfilledField[]) => any) | undefined;
+onMounted?: (() => any) | undefined;
+"onData-initialed"?: ((formKey: string) => any) | undefined;
+}>, {
+requestFn: RequestFunction;
+scenario: string;
+anchorTabsPlacement: 'left' | 'right';
+showUnfulfilledTips: boolean;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export declare const ZYFormGroup: DefineComponent<ExtractPropTypes<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_2<{
+components: UIComponentsWithTab;
+config: Form[];
+data: Record<string, any>;
+readonly?: boolean | undefined;
+static?: boolean | undefined;
+disabled?: boolean | undefined;
+requestFn?: RequestFunction | undefined;
+scenario?: string | undefined;
+requiredFieldOnly?: boolean | undefined;
+containChildFormInTabs?: boolean | undefined;
+defaultTabKey?: string | undefined;
+showUnfulfilledTips?: boolean | undefined;
+}>, {
+requestFn: undefined;
+scenario: undefined;
+defaultTabKey: undefined;
+showUnfulfilledTips: boolean;
+}>>, {
+resetFormData: (formKey?: string | string[] | undefined) => Promise<void>;
+initFormData: (newData?: Record<string, any> | undefined) => Promise<void>;
+validate: (formKey?: string | string[] | undefined, maxLevel?: number, showUnfulfilled?: boolean) => Promise<true | [...any[], any] | (true | [...any[], any])[] | undefined>;
+clearValidate: (formKey?: string | string[] | undefined) => void;
+getFormData: () => Record<string, any>;
+scrollTo: (formKey: string, fieldKey: string) => void;
+}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {
+"update:data": (val: Record<string, any>) => void;
+mounted: () => void;
+"data-initialed": () => void;
+"tab-change": (...args: any[]) => void;
+}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults_2<__VLS_TypePropsToRuntimeProps_2<{
+components: UIComponentsWithTab;
+config: Form[];
+data: Record<string, any>;
+readonly?: boolean | undefined;
+static?: boolean | undefined;
+disabled?: boolean | undefined;
+requestFn?: RequestFunction | undefined;
+scenario?: string | undefined;
+requiredFieldOnly?: boolean | undefined;
+containChildFormInTabs?: boolean | undefined;
+defaultTabKey?: string | undefined;
+showUnfulfilledTips?: boolean | undefined;
+}>, {
+requestFn: undefined;
+scenario: undefined;
+defaultTabKey: undefined;
+showUnfulfilledTips: boolean;
+}>>> & Readonly<{
+"onUpdate:data"?: ((val: Record<string, any>) => any) | undefined;
+onMounted?: (() => any) | undefined;
+"onData-initialed"?: (() => any) | undefined;
+"onTab-change"?: ((...args: any[]) => any) | undefined;
+}>, {
+requestFn: RequestFunction;
+scenario: string;
+showUnfulfilledTips: boolean;
+defaultTabKey: string;
+}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export { }