shcp-api-lib 1.0.0

package/dist/types/src/type/model/km-form-model.d.ts

@@ -0,0 +1,745 @@
+export declare namespace KMForm {
+    interface RelevanceRule {
+        condition: string;
+        bulk: string;
+        question: string[];
+        type: string;
+    }
+    /**
+     * 表单项目子题目
+     */
+    interface FormItemChildren {
+        /**
+         * 题目居中
+         */
+        align?: string;
+        /**
+         * 题目头部居中
+         */
+        headerAlign?: string;
+        /**
+         * 前端用样式
+         */
+        index?: boolean;
+        /**
+         * 题目是否存在添加按钮
+         */
+        addBtn?: boolean;
+        /**
+         * 题目是否存在删除按钮
+         */
+        delBtn?: boolean;
+        /**
+         * 子题目
+         */
+        column?: FormItemColumn[];
+    }
+    /**
+     * 表单项目列
+     */
+    interface FormItemColumn {
+        /**
+         * 题目关联的子题目
+         */
+        children?: FormItemChildren;
+        /**
+         * 题目名称
+         */
+        label?: string;
+        /**
+         * 题目编码
+         */
+        uuid?: string;
+        /**
+         * 父题目uuid
+         */
+        parentUuid?: string;
+        /**
+         * 题目备注信息
+         */
+        remark?: string;
+        /**
+         * 题目单位
+         */
+        unit?: string;
+        /**
+         * 题目单位选项(可选择场合有值)
+         */
+        selectUnit?: string;
+        /**
+         * 题目的类型
+         */
+        type?: string;
+        /**
+         * 题目的值
+         */
+        selectValue?: any[];
+        /**
+         * 题目所属的一级分类名称
+         */
+        oneModule?: string;
+        /**
+         * 题目所属的二级分类名称
+         */
+        twoModule?: string;
+        /**
+         * 题目的父选项名称
+         */
+        parentName?: string;
+        /**
+         * 题目的父选项值
+         */
+        parentNameValue?: string;
+        /**
+         * 题目描述备注
+         */
+        description?: string;
+        /**
+         * 题目默认值
+         */
+        value?: string;
+        /**
+         * 题目联动条件
+         */
+        optionLinkage?: string;
+        /**
+         * 题目规则类型，适用option_linkage字段
+         */
+        ruleType?: string;
+        /**
+         * 题目绑定的标签编码
+         */
+        tagCode?: string;
+        /**
+         * 同层级题目排序号
+         */
+        sort?: number;
+        /**
+         * 题目是否必填
+         */
+        required?: boolean;
+        /**
+         * 表单设置详细信息-暂且废弃
+         */
+        config?: string;
+        /**
+         * 题目是否，同步显示 1 展示
+         */
+        syncIsShow?: number;
+        /**
+         * 题目互斥题配置信息
+         */
+        mutual?: string;
+        /**
+         * 题目父子题配置信息
+         */
+        relevance?: string;
+        /**
+         * 题目关联结构信息
+         */
+        ruleValue?: any[];
+        /**
+         * 题目数据类型
+         */
+        dataType?: string;
+        /**
+         * 题目数字类最大值
+         */
+        max?: string;
+        /**
+         * 题目数字类最小值
+         */
+        min?: string;
+        /**
+         * 题目的提示
+         */
+        labelTip?: string;
+        /**
+         * 题目选项的位置 (top 上 bottom下 left左 right右)
+         */
+        labelTipPlacement?: string;
+        /**
+         * 题目的提示
+         */
+        tip?: string;
+        /**
+         * 题目的位置 (top 上 bottom下 left左 right右)
+         */
+        tipPlacement?: string;
+        /**
+         * 题目值的正常范围
+         */
+        normalRange?: string;
+        /**
+         * 题目的异常项:偏高,偏低,正常
+         */
+        abnormalError?: string;
+        /**
+         * 题目宽度
+         */
+        labelWidth?: string;
+        /**
+         * 题目颜色
+         */
+        labelColor?: string;
+        /**
+         * 标签的位置，top 上，left 左
+         */
+        labelPosition?: string;
+        /**
+         * 题目的提示语
+         */
+        placeholder?: string;
+        /**
+         * 时间类型题目值是否大于当前时间
+         */
+        isTime?: string;
+        /**
+         * 滑块验证码类型题目
+         */
+        sliderType?: string;
+        /**
+         * 滑块验证码图片类型题目
+         */
+        rotateType?: string;
+        /**
+         * 四中心才会用到的业务 查看教程
+         */
+        viewTutorial?: string;
+        /**
+         * 题目是否编辑隐藏：0（不隐藏），1（隐藏）
+         */
+        isEditHide?: number;
+        /**
+         * 题目是否查看隐藏：0（不隐藏），1（隐藏）
+         */
+        isViewHide?: number;
+        /**
+         * 多选题目最大可选数量
+         */
+        selectedMaxNum?: number;
+        /**
+         * 题目前端用样式
+         */
+        span?: number;
+        /**
+         * 题目前端用样式
+         */
+        display?: boolean;
+        /**
+         * 题目前端用样式
+         */
+        styles?: Record<string, any>;
+        /**
+         * 题目前端用
+         */
+        prop?: string;
+        /**
+         * 题目前端用
+         */
+        props?: Record<string, any>;
+        /**
+         * 题目前端用
+         */
+        dicData?: any[];
+        /**
+         * 题目单位
+         */
+        append?: string;
+        /**
+         * 关联题规则
+         */
+        rule?: RelevanceRule[];
+        /**
+         * 题目居中
+         */
+        align?: string;
+        /**
+         * 题目头部居中
+         */
+        headerAlign?: string;
+        /**
+         * 前端用样式
+         */
+        index?: boolean;
+        /**
+         * 题目是否存在添加按钮
+         */
+        addBtn?: boolean;
+        /**
+         * 题目是否存在删除按钮
+         */
+        delBtn?: boolean;
+        /**
+         * 题目绑定的标签名称
+         */
+        tagName?: string;
+        /**
+         * 题目绑定的字典id
+         */
+        valueDictId?: number | string;
+        /**
+         * 是否支持AI识别
+         */
+        aiRecognition?: boolean;
+        /**
+         * AI识别文件记录
+         */
+        aiRecognitionRecord?: string;
+        /**
+         * 编辑隐藏端点
+         */
+        editHideEndpoints?: string;
+        /**
+         * 查看隐藏端点
+         */
+        viewHideEndpoints?: string;
+        autoOverwriteNull?: boolean;
+        /**
+         * 只读
+         */
+        readonly?: boolean;
+    }
+    /**
+     * 表单一级标题
+     */
+    interface FormItemGroup {
+        /**
+         * 一级标题名称
+         */
+        label?: string;
+        /**
+         * 图标
+         */
+        icon?: string;
+        /**
+         * 属性
+         */
+        prop?: string;
+        /**
+         * 箭头
+         */
+        arrow?: boolean;
+        /**
+         * 折叠
+         */
+        collapse?: boolean;
+        /**
+         * 显示
+         */
+        display?: boolean;
+        /**
+         * 题目组关联子组
+         */
+        column?: FormItemColumn[];
+        /**
+         * 一级标题标签code
+         */
+        tagCode?: string;
+        /**
+         * 一级标题标签名称
+         */
+        tagName?: string;
+        /**
+         * 一级标题uuid
+         */
+        uuid?: string;
+        /**
+         * 一级标题排序
+         */
+        sort?: number;
+        /**
+         * 是否支持AI识别
+         */
+        aiRecognition?: boolean;
+        /**
+         * AI识别文件记录
+         */
+        aiRecognitionRecord?: string;
+        /**
+         * 编辑隐藏端点
+         */
+        editHideEndpoints?: string;
+        /**
+         * 查看隐藏端点
+         */
+        viewHideEndpoints?: string;
+        /**
+         * 只读
+         */
+        readonly?: boolean;
+        /**
+         * 自动覆盖空值
+         */
+        autoOverwriteNull?: boolean;
+    }
+    /**
+     * 表单分类DTO
+     */
+    interface FormCategoryDTO {
+        /**
+         * id
+         */
+        id?: number;
+        /**
+         * 名称
+         */
+        name?: string;
+        /**
+         * 父id
+         */
+        parentId?: number;
+        /**
+         * 是否有孩子节点，0不存在，1存在
+         */
+        hasChildren?: number;
+        /**
+         * 子分类
+         */
+        children?: FormCategoryDTO[];
+        /**
+         * 创建时间
+         */
+        createTime?: string;
+        /**
+         * 排序
+         */
+        sort?: number;
+    }
+    /**
+     * 表单分类树查询
+     */
+    interface FormCategoryTreeQuery {
+        /**
+         * 租户id
+         */
+        tenantId: string;
+        /**
+         * 根分类id
+         */
+        rootId?: number;
+    }
+    /**
+     * 表单树节点DTO
+     */
+    interface FormTreeNodeDTO {
+        /**
+         * 节点id
+         */
+        id?: number | string;
+        /**
+         * 所属树形表单id
+         */
+        formId?: number | string;
+        /**
+         * 父节点id
+         */
+        parentId?: number | string;
+        /**
+         * 节点名称
+         */
+        name?: string;
+        /**
+         * 树节点描述
+         */
+        remark?: string;
+        /**
+         * 关联表单id
+         */
+        relatedFormId?: number | string;
+        /**
+         * 是否有孩子节点
+         */
+        hasChild?: number;
+        /**
+         * 表单名称
+         */
+        formName?: string;
+        /**
+         * 创建时间
+         */
+        createTime?: string;
+        /**
+         * 孩子节点
+         */
+        children?: FormTreeNodeDTO[];
+        /**
+         * 一级标题
+         */
+        group?: FormItemGroup[];
+    }
+    /**
+     * 表单DTO
+     */
+    interface FormDTO {
+        /**
+         * id
+         */
+        id?: number;
+        /**
+         * uuid
+         */
+        uuid?: string;
+        /**
+         * 表单名称
+         */
+        name?: string;
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单描述
+         */
+        remark?: string;
+        /**
+         * 过度页
+         */
+        cover?: string;
+        /**
+         * 表单类型
+         */
+        type?: number;
+        /**
+         * 表单状态
+         */
+        status?: number;
+        /**
+         * 题目数量
+         */
+        itemCount?: number;
+        /**
+         * 创建时间
+         */
+        createTime?: string;
+        /**
+         * 创建人id
+         */
+        createUser?: number;
+        /**
+         * 创建人名称
+         */
+        createUserName?: string;
+        /**
+         * 分类id集合
+         */
+        categoryIdList?: number[];
+        /**
+         * 草稿题目数量
+         */
+        draftItemCount?: number;
+        /**
+         * 表单树子节点数量
+         */
+        childrenNodeCount?: number;
+    }
+    /**
+     * 表单查询
+     */
+    interface FormQuery {
+        /**
+         * 租户id
+         */
+        tenantId: string;
+        /**
+         * 名称-模糊匹配
+         */
+        name?: string;
+        /**
+         * 名称-精确匹配
+         */
+        nameExact?: string;
+        /**
+         * 表单类型
+         */
+        type?: number;
+        /**
+         * 创建时间
+         */
+        startTime?: string;
+        /**
+         * 结束时间
+         */
+        endTime?: string;
+        /**
+         * 状态
+         */
+        statusList?: (number | string)[];
+        status?: number | string;
+        /**
+         * 是否是草稿
+         */
+        isDraft?: number;
+        /**
+         * 可见性
+         */
+        visibility?: string;
+        /**
+         * 创建人名称
+         */
+        createUserName?: string;
+        /**
+         * 分类ID列表
+         */
+        categoryIdList?: number[];
+        /**
+         * 表单id
+         */
+        id?: number;
+    }
+    /**
+     * 表单结果DTO
+     */
+    interface FormResultDTO {
+        /**
+         * id
+         */
+        id?: number | string;
+        /**
+         * 表单uuid
+         */
+        uuid?: string;
+        /**
+         * 表单名称
+         */
+        name?: string;
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单描述
+         */
+        remark?: string;
+        /**
+         * 封面
+         */
+        cover?: string;
+        /**
+         * 表单类型
+         */
+        type?: number;
+        /**
+         * 表单状态
+         */
+        status?: number;
+        /**
+         * 可见性
+         */
+        visibility?: string;
+        /**
+         * 一级标题
+         */
+        group?: FormItemGroup[];
+        /**
+         * 表单树节点
+         */
+        node?: FormTreeNodeDTO;
+        /**
+         * 子表单统计信息. key = ${formId}:${nodeId}
+         */
+        stat?: Record<string, FormStat>;
+    }
+    interface FormStat {
+        /**
+         * 单表单的表单ID
+         */
+        formId: number | string;
+        /**
+         * 树形表单的节点ID
+         */
+        nodeId: number | string;
+        /**
+         * 表单题目数量
+         */
+        totalItems: number;
+        /**
+         * 表单已填写题目数量
+         */
+        completedItems: number;
+        /**
+         * 保存状态
+         */
+        saveStatus: boolean;
+    }
+    /**
+     * 表单智能填充请求
+     */
+    interface FormSmartFillRequest {
+        /**
+         * 租户id
+         */
+        tenantId: string;
+        /**
+         * 消费者用户id
+         */
+        consumerId: string | number;
+        /**
+         * 待填充表单的ID
+         */
+        formId?: number | string;
+        /**
+         * 待填充的表单题目
+         */
+        items: FormSmartFillItem[];
+        /**
+         * 待分析的图片URL
+         */
+        imageUrl: string[];
+    }
+    /**
+     * 表单题目
+     */
+    interface FormSmartFillItem {
+        /**
+         * 题目名称
+         */
+        label?: string;
+        /**
+         * 题目唯一标识
+         */
+        uuid?: string;
+        /**
+         * 选项列表（适用于 radio 和 checkbox 类型）
+         */
+        option?: FormSmartFillOption[];
+        /**
+         * 题目类型 （如 input, radio, checkbox）
+         */
+        type?: string;
+        /**
+         * 题目值
+         */
+        value?: string;
+    }
+    /**
+     * 选项
+     */
+    interface FormSmartFillOption {
+        /**
+         * 选项名称
+         */
+        label?: string;
+        /**
+         * 选项值
+         */
+        value?: string;
+    }
+    /**
+     * 表单智能填充结果
+     */
+    interface FormSmartFillDTO {
+        /**
+         * 表单唯一标识
+         */
+        formId?: number;
+        /**
+         * 图片URL
+         */
+        imageUrl?: string[];
+        /**
+         * 表单题目信息
+         */
+        item?: FormSmartFillItem[];
+    }
+}