shcp-api-lib 1.0.2 → 1.0.5

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

@@ -1,3 +1,4 @@
+import type { PageRequest } from "./common-model";
 export declare namespace KMForm {
     interface RelevanceRule {
         condition: string;
@@ -523,7 +524,7 @@ export declare namespace KMForm {
         /**
          * 分类id集合
          */
-        categoryIdList?: number[];
+        categoryIdList?: (number | string)[];
         /**
          * 草稿题目数量
          */
@@ -536,7 +537,7 @@ export declare namespace KMForm {
     /**
      * 表单查询
      */
-    interface FormQuery {
+    interface FormQuery extends PageRequest {
         /**
          * 租户id
          */
@@ -742,4 +743,740 @@ export declare namespace KMForm {
          */
         item?: FormSmartFillItem[];
     }
+    /**
+     * 表单归档请求
+     */
+    interface FormArchiveRequest {
+        /**
+         * 表单id集合
+         */
+        idList: (number | string)[];
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单基础复制请求
+     */
+    interface FormBasicCopyRequest {
+        /**
+         * 模版租户ID
+         */
+        templateTenantId?: string;
+        /**
+         * 新租户ID
+         */
+        newTenantId?: string;
+        /**
+         * 复制的表单ID
+         */
+        formIds?: (number | string)[];
+    }
+    /**
+     * 表单分类批量更新请求
+     */
+    interface FormCategoryBashUpdateRequest {
+        /**
+         * 表单分类
+         */
+        formCategoryDTOList: FormCategoryDTO[];
+    }
+    /**
+     * 表单分类复制请求
+     */
+    interface FormCategoryCopyRequest {
+        /**
+         * 模版租户ID
+         */
+        templateTenantId: string;
+        /**
+         * 新租户ID
+         */
+        newTenantId: string;
+        /**
+         * 表单映射id
+         */
+        FormIdMapping?: Record<number | string, number | string>;
+    }
+    /**
+     * 表单分类删除请求
+     */
+    interface FormCategoryDeletedRequest {
+        /**
+         * 表单分类id集合
+         */
+        ids: (number | string)[];
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单分类复制响应
+     */
+    interface FormCategoryCopyResponse {
+        /**
+         * 表单分类映射id
+         */
+        formCategoryIdMapping?: Record<number | string, number | string>;
+        /**
+         * 表单分类关联映射id
+         */
+        formCategoryRelationIdMapping?: Record<number | string, number | string>;
+    }
+    /**
+     * 表单分类创建请求
+     */
+    interface FormCategoryCreateRequest {
+        /**
+         * 父分类id
+         */
+        parentId: number | string;
+        /**
+         * 分类名称
+         */
+        name: string;
+        /**
+         * 租户id
+         */
+        tenantId: string;
+    }
+    /**
+     * 表单分类查询
+     */
+    interface FormCategoryQuery {
+        /**
+         * id
+         */
+        id?: number | string;
+        /**
+         * id集合
+         */
+        idList?: (number | string)[];
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+        /**
+         * 分类名称-模糊查询
+         */
+        name?: string;
+        /**
+         * 分类名称-精确查询
+         */
+        nameExact?: string;
+        /**
+         * 父分类id
+         */
+        parentId?: number | string;
+        /**
+         * 父分类id集合
+         */
+        parentIdList?: (number | string)[];
+    }
+    /**
+     * 表单分类关联关系DTO
+     */
+    interface FormCategoryRelationDTO {
+        /**
+         * id
+         */
+        id?: number | string;
+        /**
+         * 表单id
+         */
+        formId?: number | string;
+        /**
+         * 分类id
+         */
+        categoryId?: number | string;
+    }
+    /**
+     * 表单分类关联查询入参
+     */
+    interface FormCategoryRelationQuery {
+        /**
+         * 分类id
+         */
+        categoryId?: number | string;
+        /**
+         * 分类id集合
+         */
+        categoryIdList?: (number | string)[];
+        /**
+         * 表单id
+         */
+        formId?: number | string;
+        /**
+         * 表单id集合
+         */
+        formIdList?: (number | string)[];
+    }
+    /**
+     * 表单分类更新请求
+     */
+    interface FormCategoryUpdateRequest {
+        /**
+         * id
+         */
+        id: number | string;
+        /**
+         * 父分类id
+         */
+        parentId?: number | string;
+        /**
+         * 分类名称
+         */
+        name?: string;
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单分类移动请求
+     */
+    interface FormCategoryRemoveRequest {
+        /**
+         * 要移动的分类id
+         */
+        sourceId: number | string;
+        /**
+         * 目标分类id
+         */
+        targetId: number | string;
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单内容草稿更新请求
+     */
+    interface FormContentDraftUpdateRequest {
+        /**
+         * 表单草稿id
+         */
+        id: number | string;
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单内容
+         */
+        group?: FormItemGroup[];
+    }
+    /**
+     * 表单创建请求
+     */
+    interface FormCreateRequest {
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单名称
+         */
+        name: string;
+        /**
+         * 表单描述
+         */
+        remark?: string;
+        /**
+         * 表单类型,1.单张表单，2.表单树
+         */
+        type: number;
+        /**
+         * 表单封面
+         */
+        cover?: string;
+        /**
+         * 要挂载的分类名称
+         */
+        categoryName?: string;
+        /**
+         * 表单分类ID列表
+         */
+        categoryIdList?: (number | string)[];
+        /**
+         * 表单内容
+         */
+        group?: FormItemGroup[];
+    }
+    /**
+     * 表单复制响应
+     */
+    interface FormCopyResponse {
+        /**
+         * 表单映射id
+         */
+        FormIdMapping?: Record<number | string, number | string>;
+    }
+    /**
+     * 表单复制请求
+     */
+    interface FormCopyRequest {
+        /**
+         * 源表单是否是草稿，0.否，1.是
+         */
+        sourceIsDraft: number;
+        /**
+         * 来源表单id
+         */
+        sourceFormId: number | string;
+        /**
+         * 租户id
+         */
+        tenantId: string;
+        /**
+         * 名称
+         */
+        name: string;
+        /**
+         * 描述
+         */
+        remark?: string;
+        /**
+         * 封面URL
+         */
+        cover?: string;
+        /**
+         * 分类id集合
+         */
+        categoryIdList?: (number | string)[];
+    }
+    /**
+     * 表单删除请求
+     */
+    interface FormDeletedRequest {
+        /**
+         * 表单id集合
+         */
+        idList: (number | string)[];
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单草稿项DTO
+     */
+    interface FormDraftItemDTO {
+        /**
+         * 表单组
+         */
+        group?: FormItemGroup[];
+    }
+    /**
+     * 表单草稿创建请求
+     */
+    interface FormDraftCreateRequest {
+        /**
+         * 表单id
+         */
+        formId?: number | string;
+        /**
+         * 租户id
+         */
+        tenantId: string;
+        /**
+         * 名称
+         */
+        name?: string;
+        /**
+         * 描述
+         */
+        remark?: string;
+        /**
+         * 封面URL
+         */
+        cover?: string;
+        /**
+         * 分类id集合
+         */
+        categoryIdList?: (number | string)[];
+    }
+    /**
+     * 表单草稿项查询
+     */
+    interface FormDraftItemQuery {
+        /**
+         * 表单id
+         */
+        formId?: number | string;
+        /**
+         * 表单id列表
+         */
+        formIdList?: (number | string)[];
+    }
+    /**
+     * 表单草稿结果DTO
+     */
+    interface FormDraftResultDTO {
+        /**
+         * id
+         */
+        id?: number | string;
+        /**
+         * 表单uuid
+         */
+        uuid?: string;
+        /**
+         * 表单名称
+         */
+        name?: string;
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单描述
+         */
+        remark?: string;
+        /**
+         * 封面
+         */
+        cover?: string;
+        /**
+         * 表单类型
+         */
+        type?: number;
+        /**
+         * 表单状态
+         */
+        status?: number;
+        /**
+         * 可见性
+         */
+        visibility?: string;
+        /**
+         * 分组
+         */
+        group?: FormItemGroup[];
+    }
+    /**
+     * 表单草稿提交请求
+     */
+    interface FormDraftSubmitRequest {
+        /**
+         * 表单id列表
+         */
+        formIds: (number | string)[];
+        /**
+         * 前端忽略该参数，租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单草稿更新请求
+     */
+    interface FormDraftUpdateRequest {
+        /**
+         * 表单草稿id
+         */
+        id: number | string;
+        /**
+         * 名称
+         */
+        name?: string;
+        /**
+         * 描述
+         */
+        remark?: string;
+        /**
+         * 分类id集合
+         */
+        categoryIdList?: (number | string)[];
+    }
+    /**
+     * 表单项复制请求
+     */
+    interface FormItemCopyRequest {
+        /**
+         * 模版租户ID
+         */
+        templateTenantId: string;
+        /**
+         * 新租户ID
+         */
+        newTenantId: string;
+        /**
+         * 表单映射id
+         */
+        formIdMapping?: Record<number | string, number | string>;
+    }
+    /**
+     * 表单项复制响应
+     */
+    interface FormItemCopyResponse {
+        /**
+         * 表单项关联映射id
+         */
+        formItemIdMapping?: Record<number | string, number | string>;
+    }
+    /**
+     * 表单项查询入参
+     */
+    interface FormItemQuery {
+        /**
+         * 表单ID
+         */
+        formId?: number | string;
+        /**
+         * 表单ID列表
+         */
+        formIdList?: (number | string)[];
+    }
+    /**
+     * 表单发布请求
+     */
+    interface FormPublishedRequest {
+        /**
+         * 待发布表单id集合
+         */
+        idList: (number | string)[];
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单规则关联DTO
+     */
+    interface FormRuleRelationDTO {
+        /**
+         * id
+         */
+        id?: number | string;
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单关联规则类型
+         */
+        type?: string;
+        /**
+         * 表单id
+         */
+        formId?: number | string;
+        /**
+         * 规则id
+         */
+        ruleId?: number | string;
+        /**
+         * 规则代码
+         */
+        ruleCode?: string;
+        /**
+         * 扩展数据
+         */
+        extra?: string;
+    }
+    /**
+     * 表单规则关联查询
+     */
+    interface FormRuleRelationQuery {
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单规则类型
+         */
+        type?: string;
+        /**
+         * 表单规则类型集合
+         */
+        typeList?: string[];
+        /**
+         * 表单id
+         */
+        formId?: number | string;
+        /**
+         * 规则id
+         */
+        ruleId?: number | string;
+        /**
+         * 使用域
+         */
+        extra?: string;
+    }
+    /**
+     * 表单树节点创建请求
+     */
+    interface FormTreeNodeCreateRequest {
+        /**
+         * 所属树形表单id
+         */
+        formId: number | string;
+        /**
+         * 父节点id
+         */
+        parentId: number | string;
+        /**
+         * 节点名称
+         */
+        name?: string;
+        /**
+         * 树节点描述
+         */
+        remark?: string;
+        /**
+         * 关联表单id
+         */
+        relatedFormId?: number | string;
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单树节点复制响应
+     */
+    interface FormTreeNodeCopyResponse {
+        /**
+         * 表单树关联映射id
+         */
+        formTreeIdMapping?: Record<number | string, number | string>;
+    }
+    /**
+     * 表单树节点复制请求
+     */
+    interface FormTreeNodeCopyRequest {
+        /**
+         * 源表单id
+         */
+        sourceFormId: number | string;
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId: string;
+        /**
+         * 表单名称
+         */
+        name: string;
+        /**
+         * 表单描述
+         */
+        remark?: string;
+        /**
+         * 表单封面
+         */
+        cover?: string;
+        /**
+         * 表单分类ID列表
+         */
+        categoryIdList?: (number | string)[];
+        /**
+         * 模版租户ID
+         */
+        templateTenantId?: string;
+        /**
+         * 新租户ID
+         */
+        newTenantId?: string;
+        /**
+         * 表单映射id
+         */
+        formIdMapping?: Record<number | string, number | string>;
+    }
+    /**
+     * 表单树节点删除请求
+     */
+    interface FormTreeNodeDeleteRequest {
+        /**
+         * 节点id集合
+         */
+        ids: (number | string)[];
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+        /**
+         * 表单id集合
+         */
+        formIdList?: (number | string)[];
+    }
+    /**
+     * 表单树节点查询
+     */
+    interface FormTreeNodeQuery {
+        /**
+         * id
+         */
+        id?: number | string;
+        /**
+         * id集合
+         */
+        idList?: (number | string)[];
+        /**
+         * 表单id
+         */
+        formId?: number | string;
+        /**
+         * 表单id集合
+         */
+        formIdList?: (number | string)[];
+    }
+    /**
+     * 表单树节点更新请求
+     */
+    interface FormTreeNodeUpdateRequest {
+        /**
+         * 节点id
+         */
+        id: number | string;
+        /**
+         * 节点名称
+         */
+        name?: string;
+        /**
+         * 树节点描述
+         */
+        remark?: string;
+        /**
+         * 关联表单id
+         */
+        relationFormId?: number | string;
+        /**
+         * 租户id
+         */
+        tenantId?: string;
+    }
+    /**
+     * 表单更新请求
+     */
+    interface FormUpdateRequest {
+        /**
+         * 表单ID
+         */
+        id: number | string;
+        /**
+         * 前端可以忽略，租户id
+         */
+        tenantId?: string;
+        /**
+         * 名称
+         */
+        name?: string;
+        /**
+         * 描述
+         */
+        remark?: string;
+        /**
+         * 过渡页
+         */
+        cover?: string;
+        /**
+         * 分类id集合
+         */
+        categoryIdList?: (number | string)[];
+        /**
+         * 表单内容
+         */
+        group?: FormItemGroup[];
+    }
 }