cnhis-design-vue 3.1.14-beta.9 → 3.1.14

package/es/packages/form-render/src/types/fieldItem.d.ts

@@ -1,14 +1,24 @@
 import { AnyObject, ArrayAble } from '../../../../../es/src/types';
+import { SchemaReaction } from '@formily/json-schema/esm/types';
+import { SchemaTypes } from '@formily/vue';
 import { CSSProperties, VNode } from 'vue';
+import { DependKeyType, FormCommonState } from '../../../../../es/packages/form-render';
+import { FIELD_BUSINESS_TYPE } from '../../../../../es/packages/form-render/src/constants';
 export declare type ValidateItem = Partial<{
-    obj_type: string;
+    /**
+     * 业务类型
+     */
+    obj_type: FIELD_BUSINESS_TYPE;
+    /**
+     * 校验类型
+     */
     vali_obj: string;
     max_value: string | number;
     min_value: string | number;
     min_length: string | number;
     max_length: string | number;
     decimal_length: string | number;
-    regular_expression: any;
+    regular_expression: RegExp | string;
     regular_error_tip: string;
     [key: string]: any;
 }>;
@@ -17,10 +27,6 @@ interface OptionItem {
     value: any;
     children?: OptionItem[];
 }
-export interface Ievent {
-    event_field: string;
-    event_type: string;
-}
 interface FormRendererPayload {
     clearable: boolean;
     disabled: boolean;
@@ -36,64 +42,146 @@ interface SwitchProperty {
     describe?: string;
 }
 export declare type FieldItem = {
+    /**
+     * 字段的key
+     */
     val_key: string;
+    /**
+     * 控件类型
+     */
     html_type: string;
 } & Partial<{
+    /**
+     * 是否开启批注(需要先在表单维度开启)
+     */
     annotation: boolean;
+    /**
+     * 定制化字段, AGE类型控件时的单位字段
+     */
     val_key_unit: string;
-    is_edit: string;
+    /**
+     * 是否允许编辑('1'为允许编辑)
+     */
+    is_edit: FormCommonState;
+    /**
+     * 控件在栅栏系统中的的宽度值, 默认为3
+     */
     elem_width: number;
-    is_show: string | number;
-    is_null: string;
+    /**
+     * 是否展示('1'为展示)
+     */
+    is_show: FormCommonState;
+    /**
+     * 是否允许为空('1'为允许为空)
+     */
+    is_null: FormCommonState;
+    /**
+     * 字段label
+     */
     name: string;
+    /**
+     * 字段label(优先级比name高)
+     */
     alias: string;
+    /**
+     * 默认值
+     */
     default_val: any;
-    is_empty: string;
-    group: string;
-    hide_title: string;
+    /**
+     * 是否开启清空功能('0'表示开启)
+     */
+    is_empty: FormCommonState;
+    /**
+     * 是否隐藏label('1'表示隐藏)
+     */
+    hide_title: FormCommonState;
     placeholder: string;
     validate: ValidateItem;
     option: OptionItem[];
-    wordbook: AnyObject;
-    suFieldList: any[];
-    bindEventSetting: Ievent[];
+    /**
+     * 用于cascader控件提供层级参数
+     */
+    wordbook: {
+        level_num: number;
+    };
+    /**
+     * switch控件,开启状态参数
+     */
     open: SwitchProperty;
+    /**
+     * switch控件,关闭状态参数
+     */
     close: SwitchProperty;
+    /**
+     * date控件value格式
+     */
     date_format: string;
+    /**
+     * slider控件间距
+     */
     step_length: string | number;
     urlConfig: Partial<{
         url: string;
         method: 'post' | 'get' | 'put' | 'patch' | 'delete';
-        dependKey: string | string[] | Record<string, string>;
+        /**
+         * 请求参数依赖关系
+         */
+        dependKey: DependKeyType;
         params: AnyObject;
         nameKey: string;
         valueKey: string;
     }>;
-    suffixConfig: FieldItem[] | FieldItem;
-    fieldType: 'string' | 'object' | 'array' | 'number' | 'void' | 'boolean' | 'datetime';
+    /**
+     * 控件组
+     */
+    suffixConfig: ArrayAble<FieldItem>;
+    /**
+     * 数据类型
+     */
+    fieldType: SchemaTypes;
+    /**
+     * BUTTON/TEXT控件内容
+     */
     content: string | FormRenderer | Record<string, FormRenderer>;
-    properties: FieldItem[];
+    /**
+     * COMBINATION控件最大表单组数量
+     */
+    maxGroupNum: number;
+    /**
+     * COMBINATION控件子项
+     */
     children: FieldItem[];
+    /**
+     * 子项
+     */
+    properties: FieldItem[];
+    /**
+     * 控件额外的props
+     */
     componentProps: AnyObject;
+    /**
+     * FormItem额外的props
+     */
     decoratorProps: AnyObject;
+    /**
+     * COMPLEX控件布局类型
+     */
     display: 'grid' | 'flex';
+    /**
+     * COMPLEX控件额外样式
+     */
     wrapperStyle: CSSProperties | Record<string, string>;
-    validator: (value: any, fieldItem: FieldItem) => void | string;
-    reactions: {
-        target?: string;
-        dependencies?: string[];
-        fulfill: {
-            state?: Partial<{
-                value: string;
-                disabled: string;
-                display: string;
-                componentProps: AnyObject;
-                decoratorProps: AnyObject;
-                selfErrors: string;
-                [key: string]: string | AnyObject;
-            }>;
-        };
-    };
+    /**
+     * 自定义校验规则
+     * @param value 表单当前控件的值
+     * @param fieldItem 配置参数
+     * @return {void|string} 返回校验信息
+     */
+    validator: (value: unknown, fieldItem: FieldItem) => void | string;
+    /**
+     * 表单联动配置
+     */
+    reactions: ArrayAble<SchemaReaction>;
     [key: string]: any;
 }>;
 export {};

package/es/packages/form-render/src/types/index.d.ts

@@ -1,9 +1,10 @@
-import { AnyObject } from '../../../../../es/src/types';
+import { AnyObject, ArrayAble } from '../../../../../es/src/types';
 import { DataField, Field } from '@formily/core';
 import { FIELD_BUSINESS_TYPE } from '../../../../../es/packages/form-render/src/constants';
 import { FieldItem } from '../types';
 import { AsyncQueue } from '../hooks';
 export * from './fieldItem';
+export declare type FormCommonState = '0' | '1';
 export interface FieldVisitorContext {
     field: FieldItem;
     replace(f: FieldItem): void;
@@ -15,7 +16,7 @@ export declare type FormRequestType = 'post' | 'get' | 'patch' | 'delete' | 'put
 export interface FormAsyncQueueItem {
     key: any;
     url: string;
-    method: FormRequestType;
+    method?: FormRequestType;
     params?: AnyObject;
 }
 export declare type FormAsyncQueue = AsyncQueue<FormAsyncQueueItem, any, AnyObject[]>;
@@ -48,3 +49,4 @@ export declare type FormBusinessFilter = (payload: {
     type: FIELD_BUSINESS_TYPE;
     context?: any;
 }) => unknown;
+export declare type DependKeyType = ArrayAble<string> | Record<string, string> | ArrayAble<Record<'paramName' | 'paramValue', string>>;

package/es/packages/form-render/src/utils/index.d.ts

@@ -2,7 +2,7 @@ import { AnyObject, ArrayAble } from '../../../../../es/src/types';
 import { ISchema } from '@formily/json-schema/esm/types';
 import { GeneralField } from '@formily/core';
 import { FunctionalComponent, InjectionKey, VNode } from 'vue';
-import { AgeContext, FieldItem, IdCardParseInfo } from '../types';
+import { AgeContext, DependKeyType, FieldItem, IdCardParseInfo } from '../types';
 export declare function formRenderLog(message: string, type?: keyof Console): void;
 export declare function arrayed<T>(maybeArray: T): T extends Array<any> ? T : [T];
 export declare function assignUpdateValue(props: AnyObject, field: GeneralField): {
@@ -14,15 +14,12 @@ export declare function isMobile(mobile: string): boolean;
 export declare function parseBirthday(birthday: string): AgeContext;
 export declare function parseIdCard(idCardNo: string): IdCardParseInfo;
 export declare function injectOrProvide<T>(key: InjectionKey<T>, creator: () => T): T;
-export declare function traverseDependKey(dependKeys: ArrayAble<string> | Record<string, string> | ArrayAble<{
-    paramName: string;
-    paramValue: string;
-}>, handler: {
+export declare function traverseDependKey(dependKeys: DependKeyType, handler: {
     (dependKey: string, valueKey: string): void;
 }): void;
 export declare function traverseSchema(schema: ISchema, handler: (_s: ISchema) => void): void;
 export declare function uuidGenerator(): string;
-export declare function createSlot(renderer: unknown, props: any): Record<string, () => ArrayAble<VNode>> | {
+export declare function createSlot(renderer: unknown, props: AnyObject): Record<string, () => ArrayAble<VNode>> | {
     default(): any;
 };
 export declare function queryDecorator(key: string, wrapperElement: HTMLElement, formUUID: string): HTMLElement | null;

package/es/packages/form-table/index.js

@@ -1,7 +1,6 @@
 import { COMPONENT_NAMESPACE } from '../../src/global/variable';
 import { safeComponentRegister } from '../../src/utils';
-import './src/FormTable.js';
-import script from './src/FormTable.vue_vue_type_script_setup_true_lang.js';
+import script from './src/FormTable.js';
 
 const FormTable = script;
 FormTable.install = function(app) {